quarkdown-stdlib/com.quarkdown.stdlib.module.Document/tableofcontents

tableofcontents

.tableofcontents title:{InlineMarkdownContent? = null}
              maxdepth:{Int = 3}
                 focus:{InlineMarkdownContent? = null}
-> Node
Content copied to clipboard

Generates a table of contents for the document.

Return

a wrapped TableOfContents node

Parameters

title

title of the table of contents. If unset, the default title is used

maxdepth

maximum depth of the table of contents

focus

if set, adds focus to the item of the table of contents with the same text content as this argument. Inline style (strong, emphasis, etc.) is ignored when comparing the text content.