tableofcontents
.tableofcontents title:{InlineMarkdownContent? = null}
maxdepth:{Int = 3}
focus:{InlineMarkdownContent? = null}
-> NodeContent copied to clipboard
Generates a table of contents, based on the headings in the document, organized in a hierarchical structure defined by each heading's depth.
Return
a TableOfContents node
Parameters
title
- Optional
- Likely named
title of the table of contents. If unset, the default localized title is used
maxdepth
- Optional
- Likely named
maximum depth of the table of contents. Only headings with a depth (number of leading #s) equal to or less than this value are included.
focus
- Optional
- Likely named
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. When at least one item is focused, non-focused items are visually de-emphasized.