目录

【为github markdown生成目录】

介绍

github-markdown-toc项目是github的一个开源项目,旨在为markdown格式的readme生成目录,就像word的目录一样,可以一目了然的看到readme的大纲,对较长的readme来说尤为有用。

资源

官方地址: https://github.com/ekalinin/github-markdown-toc

使用

下载github仓库中的gh-md-toc文件,增加执行权限后,运行下述命令即可。

./gh-md-toc readme.md

就会在控制台上输出生成的目录。