Interface: RenderIndexOptions
Defined in: emitters/markdown/src/render.ts:156
Options controlling how the index renders.
Extended by
Properties
baseHref?
ts
optional baseHref?: string;Defined in: emitters/markdown/src/render.ts:162
Link prefix for page links (defaults to "/"; e.g. "/api/css/").
groups?
ts
optional groups?: readonly string[];Defined in: emitters/markdown/src/render.ts:168
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.
intro?
ts
optional intro?: string;Defined in: emitters/markdown/src/render.ts:160
An intro paragraph under the H1.
title?
ts
optional title?: string;Defined in: emitters/markdown/src/render.ts:158
The index H1 (defaults to "CSS API reference").