TableOfContents

overview:

• Generates/renders a table of contents (TOC) from Markdown headings.
• Reference: table of contents

Note

configuration:

• Add/remove/configure plugins: Configuration

Configuration

options: maxDepth: - Heading-depth limit: 1 top-level–6 all levels - Default: 3 minEntries: - Minimum heading entries required to display TOC - Default: 1 showByDefault: - Displays TOC by default; frontmatter override supported - Default: true collapseByDefault: - Initial TOC state: collapsed - Default: false layout: - Visual layout: "modern" or "legacy" - Default: "modern"

Warning

component:

• Required: Plugin.TableOfContents in quartz.config.yaml
• Controls TOC display location
• Add/remove with transformer

API

api: category: - Transformer - Component function: - ExternalPlugin.TableOfContentsTransformer() source: - quartz-community/table-of-contents install: - npx quartz plugin add github:quartz-community/table-of-contents