quartz-community/quartz
1
0
Fork 0
mirror of https://github.com/jackyzha0/quartz.git synced 2026-07-22 03:00:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
quartz/docs/plugins/TableOfContents.md
saberzero1 cce45e0718
docs: add repository, enabled, required frontmatter to all plugin docs 
Added repository, enabled, and required fields to the frontmatter of
all 44 plugin documentation files. Updated Plugins.base to include
these columns, matching the information previously in the manual tables.
Also filtered out internal plugins (Assets, Static, ComponentResources,
NotFoundPage) from the base query.
2026-05-24 19:46:42 +02:00

1.6 KiB
Raw Blame History

title tags image repository enabled required
TableOfContents
plugin/transformer
plugin/component
https://images.unsplash.com/photo-1768527338896-3765921e992d quartz-community/table-of-contents true false

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 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