目录

该插件用于为 Markdown 文档生成目录（TOC）。更多信息请参阅 table of contents。

Note

关于如何添加、移除或配置插件，请参见配置页面。

本插件接受以下配置选项：

• maxDepth: 限制目录中包含的标题层级深度，范围从 1（仅顶级标题）到 6（所有标题层级）。默认值为 3
• minEntries: 显示目录所需的最小标题条目数。默认值为 1
• showByDefault: 若为 true（默认值），目录默认显示。可通过前置元数据设置覆盖
• collapseByDefault: 若为 true，目录初始状态为折叠。默认值为 false

Warning

本插件需要在 quartz.layout.ts 中包含 Component.TableOfContents 组件来确定目录显示位置。若未包含该组件，目录将不会显示。插件与组件必须同时添加或移除。

API

• 分类: 转换器
• 函数名称: Plugin.TableOfContents()
• 源码: quartz/plugins/transformers/toc.ts