markdown - MkDocs - 如何从 index.md 中的 mkdocs.yml 创建目录

Question

我正在寻找一种在 .md 中自动包含 TOC 的方法文件。这听起来很简单，并且在 GitBook 和其他静态网站生成器中已经存在了很长时间。

是否有任何扩展支持它？

Answer 1

开箱即用，不，MkDocs 无法将任何信息传递到页面的 Markdown 文本中。但是，这可以通过 plugin 实现.您可以找到已知插件列表 here .不幸的是，该列表中的任何插件似乎都没有将全局导航传递给页面的 Markdown 文本。然而，markdownextradata和 macros插件将是一个很好的起点，因为它们都将其他信息传递给 Markdown 文本。

为了完整起见，请注意 MkDocs 具有全局导航和目录。我假设您说的是全局导航，因为您指出是否应该来自 index.yml .相比之下，TOC 是特定于页面的。每个页面都有自己的 TOC，即该页面上的标题列表。 MkDocs 使用了 TOC Python-Markdown 的扩展，其中包括支持将特定于页面的 TOC 插入到页面中。只需插入文本 [TOC]在 Markdown 文本中的任何地方单独一行，TOC 将插入那里。