fuzzko.neocities.org
My digital garden
1---
2title: TableOfContents
3tags:
4 - plugin/transformer
5---
6
7This plugin generates a table of contents (TOC) for Markdown documents. See [[table of contents]] for more information.
8
9> [!note]
10> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
11
12This plugin accepts the following configuration options:
13
14- `maxDepth`: Limits the depth of headings included in the TOC, ranging from `1` (top level headings only) to `6` (all heading levels). Default is `3`.
15- `minEntries`: The minimum number of heading entries required for the TOC to be displayed. Default is `1`.
16- `showByDefault`: If `true` (default), the TOC should be displayed by default. Can be overridden by frontmatter settings.
17- `collapseByDefault`: If `true`, the TOC will start in a collapsed state. Default is `false`.
18
19> [!warning]
20> This plugin needs the `Component.TableOfContents` component in `quartz.layout.ts` to determine where to display the TOC. Without it, nothing will be displayed. They should always be added or removed together.
21
22## API
23
24- Category: Transformer
25- Function name: `Plugin.TableOfContents()`.
26- Source: [`quartz/plugins/transformers/toc.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/toc.ts).