-
Notifications
You must be signed in to change notification settings - Fork 7
Table of contents
Giorgio Garofalo edited this page Oct 6, 2024
·
10 revisions
A table of contents is a quick summary of the document, where links to headings are displayed in a visual hierarchy.
-
paged
documents also display the corresponding page number. -
slides
documents constrain the maximum height, making it scrollable.
A ToC can be displayed through the .tableofcontents
function, with the following optional parameters:
Parameter | Description | Accepts | Default |
---|---|---|---|
title |
Title that precedes the ToC. If unset, it's automatically localized. |
Inline content | Automatically localized (e.g. Table of Contents for English) |
maxdepth |
Maximum level of headings to display. e.g. maxdepth = 2 collects # This and ## This , but not ### This . |
Integer |
3 |
focus |
If set, adds focus to the item with the same text as this argument. Inline style (strong, emphasis, etc.) is ignored when comparing the text content. |
Inline content | (none) |
- Syntax of a function call
- Declaring functions
- Dynamic typing
- Localization
- Including other Quarkdown files
- Importing external libraries
- Document metadata
- Theme
- Page format
- Page margin content
- Page counter
- Automatic page break
- Numbering
- Table of contents
- Stacks (row, column, grid)
- Align
- Container
- Box
- Collapsible
- Whitespace
- String
- Number
- Markdown content
- Boolean
- Enumeration entry
- Iterable
- Dictionary
- Range
- Lambda
- Size(s)
- Color
- Dynamic