ansonbiggs.com / mono
My monorepo ansonbiggs.com
Star
Fork 0
Watch
mono Anson-Projects brain-quartz docs plugins TableOfContents.md
1.8 kB
Markdown
at main

title: TableOfContents description: Generates and renders a table of contents from headings. tags:

This plugin generates a table of contents (TOC) for Markdown documents. See [[table of contents]] for more information.

Note

For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.

This plugin accepts the following configuration options:

  • 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.
  • minEntries: The minimum number of heading entries required for the TOC to be displayed. Default is 1.
  • showByDefault: If true (default), the TOC should be displayed by default. Can be overridden by frontmatter settings.
  • collapseByDefault: If true, the TOC will start in a collapsed state. Default is false.
  • layout: The visual layout of the TOC component. Can be "modern" or "legacy". Default is "modern".

Warning

This plugin needs the Plugin.TableOfContents component in quartz.config.yaml to determine where to display the TOC. Without it, nothing will be displayed. They should always be added or removed together.

API #

  • Category: Transformer, Component
  • Function name: ExternalPlugin.TableOfContentsTransformer().
  • Source: quartz-community/table-of-contents
  • Install: npx quartz plugin add github:quartz-community/table-of-contents