# 生成GitHub README的markdown导航目录

在GitHub的README.md文件中,我们会通过markdown语法来写文档,会有许多大小标题。当文档一长,就难以定位,这时候目录就显得很有用。可以通过gh-md-toc (opens new window)来生成导航目录。

下载gh-md-toc (opens new window)文件,然后给它执行权限:

$ chmod a+x gh-md-toc

把它放在添加到环境变量PATH上即可:

$ export PATH=$PATH:/Users/larry/Software/gh-md-toc

通过以下命令,便可以生成导航目录:

$ gh-md-toc.sh README.md 

结果如图所示:

上次更新: 2023/8/18 23:39:36