这个插件为Markdown文档生成一个目录(TOC)。参看table of contents了解更多信息。

Note

有关如何添加、删除或配置插件的信息,请参阅配置页。

此插件接受以下配置选项:

  • maxDepth: 限制目录中所列标题的深度,范围从1(仅限顶级标题)到6(所有标题级别)。默认值为3
  • minEntries: 显示目录所需的最小标题条目数。默认值为`1。
  • showByDefault: 如果true(默认值),则默认情况下应显示TOC。可以被元数据设置覆盖。
  • collapseByDefault: 如果true,TOC将以折叠状态开始。默认值为false

Warning

此插件需要Component.TableOfContents组件,以确定在何处显示TOC。没有它,什么都不会显示。应始终将它们在一起添加或删除。

API