markdown - MkDocs - 如何从 index.md 中的 mkdocs.yml 创建目录
问题描述
我正在寻找一种在.md
文件中自动包含 TOC 的方法。这听起来很简单,并且在 GitBook 和其他静态网站生成器中使用了很长时间。
是否有任何扩展支持它?
解决方案
开箱即用,不,MkDocs 无法将任何信息传递到页面的 Markdown 文本中。但是,这可以通过插件来实现。您可以在此处找到已知插件的列表。不幸的是,该列表中的任何插件似乎都没有将全局导航传递给页面的 Markdown 文本。但是,markdownextradata和宏插件将是一个很好的起点,因为它们都将其他信息传递给 Markdown 文本。
为了完整起见,请注意 MkDocs 具有全局导航和目录。我假设您说的是全局导航,因为您指出是否应该来自index.yml
. 相反,TOC 是特定于页面的。每个页面都有自己的 TOC,即仅该页面上的标题列表。MkDocs 使用 Python-Markdown 的TOC扩展,其中包括支持将特定于页面的 TOC 插入到页面中。只需将文本[TOC]
单独插入 Markdown 文本中的任何位置,TOC 就会插入其中。
推荐阅读
- lambda - 使用 groupby 的 print 和 lambda 函数
- android - How to putExtra data from strings.xml
- javascript - 如何使按键在按下时只触发一次?
- c - 返回带有指向内部结构数组的指针成员的结构是否安全?
- abap - 通过自定义报告使用 SUBMIT 时出现运行时错误“SYSTEM_ABAP_ACCESS_DENIED”
- react-native - 如何在 onChangeText 之后将文本输入值更改为零?
- css - 在 create-react-app 中的 App.css 中,背景图像不适合整个页面
- jquery - 等待光标提交 POST 表单
- c# - 为什么使用 Linq Group By Sum 会给我一个转换错误?
- c# - 比较 Form C# Visual Studio 中的两个 Date From Date 和 Database SQL Server 中的 Date