Interface: RenderEntryOptions

Defined in: emitters/markdown/src/render.ts:78

Options controlling how one entry renders.

Extended by

• BuildCssApiOptions
• EmitCssApiOptions

Properties

baseHref?

optional baseHref?: string;

Defined in: emitters/markdown/src/render.ts:91

Base href for @related cross-links (defaults to ./). Set to "" to render names without links.

---

classNames?

optional classNames?: object;

Defined in: emitters/markdown/src/render.ts:135

Optional CSS classes for HTML-preserving renderers (e.g. VitePress). Each key is opt-in; omit for pure markdown. Values are used verbatim as the class attribute (multiple space-separated tokens allowed). Renderers that strip unknown attributes (e.g. GitHub) drop the class but keep the text.

affects?

optional affects?: string;

Wrap the "Affects" marker on a modifier row carrying an @affects descendant note.

alias?

optional alias?: string;

Wrap the "Alias" marker on a modifier row carrying an @alias mapping.

deprecated?

optional deprecated?: string;

Wrap deprecation output — the record-level > [!WARNING] banner and deprecated modifier-table cells — in <span class="…">, e.g. "-instui-pill -color-warning".

interaction?

optional interaction?: string;

Wrap the "Interaction" marker on a JS-only (@interaction-flagged) modifier row.

stage?

optional stage?: Partial<Record<CssReleaseStage, string>>;

Per-stage classes for the release-stage marker on the header line (the HTML emitter's badge analog). Only the current record's stage is applied; omit a stage for pure markdown there.

---

headingPrefix?

optional headingPrefix?: string;

Defined in: emitters/markdown/src/render.ts:117

Heading prefix for the page title (defaults to no prefix, i.e. just the record name).

---

importSnippet?

optional importSnippet?: (entry) => string | undefined;

Defined in: emitters/markdown/src/render.ts:89

Produce an include/usage snippet for a record, rendered as a fenced block in the "Usage" section alongside any authored @usage prose (e.g. the @import line and class-prefix convention).

Parameters

entry

CssDocEntry

Returns

string | undefined

---

includeAnnotations?

optional includeAnnotations?: boolean;

Defined in: emitters/markdown/src/render.ts:110

Emit the ## Annotations section. Annotations are internal guidance (like @privateRemarks); defaults to false so public emitters omit them by default.

---

includeDecorators?

optional includeDecorators?: boolean;

Defined in: emitters/markdown/src/render.ts:115

Emit object-model decorators (@sealed, @frozen, @preventExtensions, @readonly) on the record meta line. Defaults to false so public emitters omit them by default.

---

members?

optional members?: readonly object[];

Defined in: emitters/markdown/src/render.ts:103

Sibling records that declared @memberOf naming this record as their parent — the inverse direction of @structure containment. Supplied by buildCssApi from the full set of records; merged into the "Subcomponents" section alongside structurally-nested children.

---

resolveComponent?

optional resolveComponent?: (className) => 
  | {
  href: string;
  name: string;
}
  | undefined;

Defined in: emitters/markdown/src/render.ts:97

Resolve a bare class name to the component whose base class it is (for @structure sibling references) — returns the component's name + page href, else undefined. Supplied by buildCssApi from the full set of records; powers the "Subcomponents" section.

Parameters

className

string

Returns

| { href: string; name: string; } | undefined

---

resolveDemo?

optional resolveDemo?: (entry) => string | undefined;

Defined in: emitters/markdown/src/render.ts:82

Choose the demo spec for an entry (defaults to entry.demo).

Parameters

entry

CssDocEntry

Returns

string | undefined

---

resolveSource?

optional resolveSource?: ResolveSource;

Defined in: emitters/markdown/src/render.ts:84

Resolve a record to a source link, rendered on the meta line as **Source:** [label](href).

---

resolveToken?

optional resolveToken?: ResolveToken;

Defined in: emitters/markdown/src/render.ts:80

Resolve a consumed token's type/value (adds Type + Value columns to "Tokens consumed").

---

sectionOrder?

optional sectionOrder?: readonly SectionKey[];

Defined in: emitters/markdown/src/render.ts:105

Reorder (or drop) the ## sections; defaults to DEFAULT_SECTION_ORDER.

---

structureVariantView?

optional structureVariantView?: "diagram" | "sections";

Defined in: emitters/markdown/src/render.ts:129

How alternative DOM shapes (from top-level @variant blocks in @structure) render, when present: "diagram" emits one combined flowchart with a labelled subgraph per variant; "sections" emits a ### Variant: <name> subsection per variant, each with its own text tree/diagram per structureView. Defaults to "diagram". Ignored when no @variant was authored.

---

structureView?

optional structureView?: "text" | "diagram" | "both";

Defined in: emitters/markdown/src/render.ts:122

Which representation(s) the ## Structure section emits: the ```text tree, the ```mermaid flowchart, or both. Defaults to "both".