如何为 Markdown 文件(即 .md 格式的文件)自动生成目录?
下面给大家介绍两种方法:
-
Visual Studio Code + Markdown TOC 扩展
-
Pandoc 命令
一、Visual Studio Code + TOC 扩展
Visual Studio Code (VS Code) 是一个由微软开发的,同时支持 Windows、Linux 和 macOS 操作系统的开源文本编辑器。它支持调试,内置了 Git 版本控制功能,同时也具有开发环境功能,例如代码补全、代码片段、代码重构等。VS Code 编辑器支持用户自定义配置,例如改变主题颜色、键盘快捷方式、编辑器属性和其他参数。另外,还支持扩展程序,并在编辑器中内置了扩展程序管理的功能。
VS Code 图标介绍,可以参考:
使用 VS Code + TOC 扩展为 Markdown 文件自动生成目录,具体操作步骤如下:
1)安装扩展 Markdown TOC
2) 在VS Code中打开markdown.md文档,在想要插入目录的地方 右键单击 Markdown TOC: Insert/Update,目录即自动插入。
3)单击右上角的预览图标,可查看目录的显示效果
4)注:为保持文档整洁,删除目录首尾的如下字符
5)保存文件,关闭文件
二、Pandoc 命令
Pandoc 是由 John MacFarlane 开发的标记语言转换工具,可实现不同标记语言间的格式转换,堪称该领域中的“瑞士军刀”。Pandoc 使用 Haskell 语言编写,以命令行形式实现与用户的交互,可支持多种操作系统。
如何使用 pandoc 命令为 Markdown 文件自动生成目录呢?仍以 test.md 文件为例,具体操作步骤如下:
1) 输入以下命令,即可自动生成目录
注:pandoc 默认生成三级目录。以上述命令为例,加了个参数 –toc-depth。如果使用如下命令则只会生成三级目录:
2)打开 .md 文档,查看目录
pandoc 的更多功能和参数使用,可参考 pandoc 官网的文档: