Skip to content

Commit

Permalink
docs: document enableToc
Browse files Browse the repository at this point in the history
  • Loading branch information
jackyzha0 committed Sep 20, 2023
1 parent 52a172d commit 0bad3ce
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/features/table of contents.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ tags:
Quartz can automatically generate a table of contents from a list of headings on each page. It will also show you your current scroll position on the site by marking headings you've scrolled through with a different colour.

By default, it will show all headers from H1 (`# Title`) all the way to H3 (`### Title`) and will only show the table of contents if there is more than 1 header on the page.
You can also hide the table of contents on a page by adding `showToc: false` to the frontmatter for that page.

> [!info]
> This feature requires both `Plugin.TableOfContents` in your `quartz.config.ts` and `Component.TableOfContents` in your `quartz.layout.ts` to function correctly.
Expand Down

0 comments on commit 0bad3ce

Please sign in to comment.