Skip to main content

Function: tableOfContents()

tableOfContents(maxDepth, ...s): string

Defined in: lib/markdown.ts:715

Function to create a table of contents from the headers in the markdown.

Parameters​

maxDepth​

number

The maximum depth of the table of contents.

s​

...string[]

The markdown to generate the table of contents from.

Returns​

string

The table of contents markdown.