markdown文件生成目录的方式

markdown语法简单好上手,在项目中很多文档都是采用markdown语法完成的,以下介绍两种在markdown文档中自动生成目录的方式。
一、有道自动生成

在文章开始地方输入[toc],即可在对应位置插入目录

 
[toc]

注意:凡是文章标题带有#(1-6个)的都会被捕获到目录中。

二、npm 语法生成

全局安装doctoc插件

npm i doctoc -g //install 简写 i

假如你的markdown文件在work/demo.md文件下,只需要cd work 切换到当前文件目录下,执行doctoc demo.md文件,即可在文档中自动生成目录。

 
doctoc

三、两种方式的优缺点

1.有道生成目录

优点是:简单快捷,

缺点是:直接生成文字目录,没有生成相应的目录连接

2.npm doctoc生成目录

优点:生成了相应的目录连接(例如:文章段落一有地方要跳转到段落二,这时候有目录链接就很方便的完成跳转了)

缺点:依赖npm



作者:lemonzoey
链接:https://www.jianshu.com/p/b0a18eb32d09
来源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

posted on 2021-07-08 16:05  ExplorerMan  阅读(2771)  评论(0编辑  收藏  举报

导航