生成GitHub中Readme的目录

前言

• markdown的语法其实一直都没有统一的版本，GitHub的readme就很神奇的不支持[toc]，无法自动生成目录
• 也有很多人写了生成目录的脚本等等，但很多都是还要配环境等等，因此我在这里推荐的是一款输入命令即可使用的插件
• GitHub地址github-markdown-toc

使用方法

安装

//mac 其他版本可以去看原仓库的readme
$ curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc
$ chmod a+x gh-md-toc

使用

./gh-md-toc 本地文件路径/GitHub markDown链接

➥ ./gh-md-toc ~/projects/Dockerfile.vim/README.md 
➥ ./gh-md-toc https://github.com/ekalinin/envirius/blob/master/README.md

说明

• 但并不是说执行后就自动添加了，执行后会在控制台里打印出目录，是需要手动粘贴到GitHub 上的
•