5

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

是否有任何扩展支持它?

4

1 回答 1

1

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

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

于 2019-07-31T14:13:59.243 回答