Skip to content

Function: renderIndex() ​

ts
function renderIndex(entries, options?): string;

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

Render the index/overview page: records grouped by @group (or their kind), each a table with its summary. See groupEntries for the grouping and order.

Parameters ​

entries ​

readonly CssDocEntry[]

options? ​

RenderIndexOptions = {}

Returns ​

string

Released under the MIT License