Interface: BuildCssApiOptions
Defined in: emitters/markdown/src/build.ts:31
Options for buildCssApi.
Extends
Properties
baseHref?
baseHref?: string;Defined in: emitters/markdown/src/render.ts:99
Base href for @related cross-links (defaults to ./). Set to "" to render names without links.
Inherited from
classNames?
classNames?: object;Defined in: emitters/markdown/src/render.ts:143
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?
affects?: string;Wrap the "Affects" marker on a modifier row carrying an @affects descendant note.
alias?
alias?: string;Wrap the "Alias" marker on a modifier row carrying an @alias mapping.
deprecated?
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?
interaction?: string;Wrap the "Interaction" marker on a JS-only (@interaction-flagged) modifier row.
stage?
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.
Inherited from
configuration?
configuration?: CssDocConfiguration;Defined in: emitters/markdown/src/build.ts:37
The tag configuration to parse with (e.g. from @cssdoc/config).
css
css: string | string[];Defined in: emitters/markdown/src/build.ts:33
The CSS source (one string, or several concatenated).
dialect?
dialect?: CssDialect;Defined in: emitters/markdown/src/build.ts:41
The stylesheet dialect of css (scss/less pick a dialect parser). Default css.
exampleFilter?
exampleFilter?: ExampleFilter | null;Defined in: emitters/markdown/src/render.ts:86
Select rendered examples. Omit or pass null to show all examples.
Inherited from
RenderEntryOptions.exampleFilter
groups?
groups?: readonly string[];Defined in: emitters/markdown/src/render.ts:176
Explicit group order for the sidebar and index. Listed labels come first, in this order; any unlisted group follows in the default order (KIND_GROUPS kinds, then custom @group groups in first-appearance order). Omitted → the default order. See groupEntries.
Inherited from
headingPrefix?
headingPrefix?: string;Defined in: emitters/markdown/src/render.ts:125
Heading prefix for the page title (defaults to no prefix, i.e. just the record name).
Inherited from
RenderEntryOptions.headingPrefix
importSnippet?
importSnippet?: (entry) => string | undefined;Defined in: emitters/markdown/src/render.ts:97
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
Returns
string | undefined
Inherited from
RenderEntryOptions.importSnippet
includeAnnotations?
includeAnnotations?: boolean;Defined in: emitters/markdown/src/render.ts:118
Emit the ## Annotations section. Annotations are internal guidance (like @privateRemarks); defaults to false so public emitters omit them by default.
Inherited from
RenderEntryOptions.includeAnnotations
includeDecorators?
includeDecorators?: boolean;Defined in: emitters/markdown/src/render.ts:123
Emit object-model decorators (@sealed, @frozen, @preventExtensions, @readonly) on the record meta line. Defaults to false so public emitters omit them by default.
Inherited from
RenderEntryOptions.includeDecorators
includeInternal?
includeInternal?: boolean;Defined in: emitters/markdown/src/render.ts:178
Include records marked @visibility internal; defaults to false.
Inherited from
RenderIndexOptions.includeInternal
intro?
intro?: string;Defined in: emitters/markdown/src/render.ts:168
An intro paragraph under the H1.
Inherited from
lang?
lang?: "css" | "markdown" | "html" | "js";Defined in: emitters/markdown/src/build.ts:39
The host language css is written in. Non-css values extract embedded CSS first. Default css.
members?
members?: readonly object[];Defined in: emitters/markdown/src/render.ts:111
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.
Inherited from
outDir
outDir: string;Defined in: emitters/markdown/src/build.ts:35
The output directory (created if missing).
providers?
providers?: object;Defined in: emitters/markdown/src/build.ts:49
Upstream cssdoc providers this doc set consumes (from resolveProviders in @cssdoc/config). Their components become cross-link targets, so an @structure reference or Subcomponents entry pointing at a provider component links out to the provider's rendered page (via its href).
entries
entries: readonly CssDocEntry[];href
href: (className) => string | undefined;Parameters
className
string
Returns
string | undefined
resolveComponent?
resolveComponent?: (className) =>
| {
href: string;
name: string;
}
| undefined;Defined in: emitters/markdown/src/render.ts:105
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
Inherited from
RenderEntryOptions.resolveComponent
resolveDemo?
resolveDemo?: (entry) => string | undefined;Defined in: emitters/markdown/src/render.ts:90
Choose the demo spec for an entry (defaults to entry.demo).
Parameters
entry
Returns
string | undefined
Inherited from
RenderEntryOptions.resolveDemo
resolveSource?
resolveSource?: ResolveSource;Defined in: emitters/markdown/src/render.ts:92
Resolve a record to a source link, rendered on the meta line as **Source:** [label](href).
Inherited from
RenderEntryOptions.resolveSource
resolveToken?
resolveToken?: ResolveToken;Defined in: emitters/markdown/src/render.ts:88
Resolve a consumed token's type/value (adds Type + Value columns to "Tokens consumed").
Inherited from
RenderEntryOptions.resolveToken
sectionOrder?
sectionOrder?: readonly SectionKey[];Defined in: emitters/markdown/src/render.ts:113
Reorder (or drop) the ## sections; defaults to DEFAULT_SECTION_ORDER.
Inherited from
RenderEntryOptions.sectionOrder
sidebarFileName?
sidebarFileName?: string;Defined in: emitters/markdown/src/build.ts:43
The sidebar file name (defaults to css-sidebar.json).
structureVariantView?
structureVariantView?: "diagram" | "sections";Defined in: emitters/markdown/src/render.ts:137
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.
Inherited from
RenderEntryOptions.structureVariantView
structureView?
structureView?: "text" | "diagram" | "both";Defined in: emitters/markdown/src/render.ts:130
Which representation(s) the ## Structure section emits: the ```text tree, the ```mermaid flowchart, or both. Defaults to "both".
Inherited from
RenderEntryOptions.structureView
title?
title?: string;Defined in: emitters/markdown/src/render.ts:166
The index H1 (defaults to "CSS API reference").