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

Question

我正在寻找一种在.md文件中自动包含目录的方法。这听起来像是一件微不足道的事情，并且在 GitBook 和其他静态网站生成器中已经存在很长时间了。

有什么扩展支持吗？

Answer 1

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

为了完整起见，请注意 MkDocs 具有全局导航和目录。我假设您正在谈论全局导航，因为您指出 if 应该来自index.yml。相反，目录是特定于页面的。每个页面都有自己的目录，即该页面上的标题列表。MkDocs 利用Python-Markdown 的TOC扩展，其中包括对将特定于页面的 TOC 插入页面的支持。只需将文本[TOC]单独插入 Markdown 文本中的任意位置，目录就会插入其中。