doctoc教程

背景

在写第一周任务的记录时，发现文档写得太长了，觉得应该要加个目录。网上搜到了doctoc项目能实现我需要的功能。

doctoc官方的介绍是

Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites via a command line flag.

安装

命令行输入

$ npm install -g doctoc

需要已经安装node.js

使用

cd到markdown文件(例如ex1.md)所在目录，然后命令行使用

$ doctoc ex1.md

如果想给这个目录和所有子目录的文件都添加文档目录，用

$ doctoc .

使用效果

注意事项

标题如果有'.'等符号，生成的目录可能无法正确链接！

另外的方法

用marked-toc加目录也可以

安装

$ npm i -g marked-toc --save

使用

文件里在想加目录的地方写 然后

$ toc [filename]