markdown文件生成目录的方式

Posted 2023-04-13

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

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

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

二、npm 语法生成

全局安装doctoc插件

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

三、两种方式的优缺点

1.有道生成目录

优点是：简单快捷，

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

2.npm doctoc生成目录

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

缺点：依赖npm

如何让 markdown 生成带目录的 html 文件 ?

参考技术A 想要让 markdown 文件生成下面这种带侧边栏目录的 html 文件,
只需要1分钟就能搞定.

npm install -g i5ting_toc

举个栗子:
你的 sample.md 文件放在桌面上
cd /Users/dora/Desktop/

i5ting_toc -f sample.md -o

然后,
就没有然后了.....
是不是超级简单!!!!!

此时你的桌面上就会出现一个 preview 的文件夹

点开看, 就是你想要的.