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

Question

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

有扩展支持它吗？

Answer 1

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

为完整起见，请注意，MkDocs同时具有全局导航和目录。我假设您正在谈论全局导航，因为您指出是否应该来自index.yml。相反，TOC是特定于页面的。每个页面都有自己的目录，这是该页面标题的列表。 MkDocs利用了Python Markdown的TOC扩展名，该扩展名支持将特定于页面的目录插入页面。只需将文本[TOC]本身插入Markdown文本中任何位置的一行，目录就会插入到那里。