alrayyes/wiki
1
0
Fork 0
mirror of https://github.com/alrayyes/wiki.git synced 2024-11-29 22:46:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
wiki/docs/plugins/TableOfContents.md
Eiko Wagenknecht 1929241a62
docs: update plugin documentation (#888) 
* docs: first few plugins documented

* docs: move plugin info

* docs: move plugin docs to tag based system

* docs: update latex example code snippet

* docs: fix spelling of latex in title

* docs: add missing linebreak

* docs: remove plugin tag from feature pages

* docs: shorten titles

* docs: refine wording

* docs: move plugin details for frontmatter

* docs: add features/* tags

* docs: update latex example

* docs: make references more explicit

* docs: add stubs for the remaining plugins

* docs: more descriptions

* docs: fix feature tags

* docs: descriptions

* docs: new plugin pages

* docs: update configuration page

* docs: more plugin work

* docs: run prettier

* docs: remove comments in config file and add link to docs

* docs: minor fixes

* docs: run prettier

* docs: spelling

* docs: update docs/plugins/AliasRedirects.md

Co-authored-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>

* docs: update docs/plugins/Assets.md

Co-authored-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>

* docs: update docs/plugins/CNAME.md

Co-authored-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>

* docs: update docs/plugins/Static.md

Co-authored-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>

* docs: update docs

* docs: update docs/features/Mermaid diagrams.md

Co-authored-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>

* docs: update docs/plugins/RemoveDrafts.md

Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>

* docs: update docs/plugins/Assets.md

Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>

* docs: update docs/configuration.md

Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>

* docs: update docs/configuration.md

Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>

* docs: update docs/configuration.md

Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>

* docs: some updates

* docs: work in review comments

---------

Signed-off-by: Eiko Wagenknecht <git@eiko-wagenknecht.de>
Co-authored-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>
Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
2024-02-23 12:07:53 -08:00

1.2 KiB
Raw Blame History

title tags
TableOfContents
plugin/transformer

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.

Warning

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.

API