生成GitHub README的markdown导航目录
source link: https://www.pkslow.com/archives/gh-md-toc
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
敢一行,则予知。脚踏实地,知行合一。
在GitHub的README.md
文件中,我们会通过markdown语法来写文档,会有许多大小标题。当文档一长,就难以定位,这时候目录就显得很有用。可以通过gh-md-toc来生成导航目录。
下载gh-md-toc文件,然后给它执行权限:
$ chmod a+x gh-md-toc
把它放在添加到环境变量PATH上即可:
$ export PATH=$PATH:/Users/larry/Software/gh-md-toc
通过以下命令,便可以生成导航目录:
$ gh-md-toc.sh README.md
结果如图所示:
Code for all: GitHub
欢迎关注微信公众号<南瓜慢说>,将持续为你更新...
Recommendations:
Cloud Native
Terraform
Container: Docker/Kubernetes
Spring Boot / Spring Cloud
Https
如何制定切实可行的计划并好好执行
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK