Markdown文件生成目录的方式

作者:php是最好的2024.02.16 10:46浏览量:4

简介:Markdown是一种轻量级标记语言,它使用简洁的语法来描述文本的格式。在Markdown文件中,可以使用特定的语法来自动生成目录。

Markdown文件可以使用两种方式生成目录:一种是有道自动生成,另一种是使用npm doctoc插件生成。以下是两种方式的详细介绍:

方式一:有道自动生成

  1. 在文章开始的地方输入[toc],即可在对应位置插入目录。
  2. 凡是文章标题带有#(1-6个)的都会被捕获到目录中。

优点:简单快捷。
缺点:直接生成文字目录,没有生成相应的目录连接。

方式二:使用npm doctoc插件生成

  1. 全局安装doctoc插件。
  2. 切换到当前文件目录下,执行doctoc demo.md命令,即可在文档中自动生成目录。

优点:生成了相应的目录连接(例如:文章段落一有地方要跳转到段落二,这时候有目录链接就很方便的完成跳转了)。
缺点:需要依赖npm安装插件。

通过以上方式,你可以在Markdown文件中自动生成目录,提高文档的可读性和易用性。