你还在为生成Github README.md的目录发愁吗?

小哥哥,小姐姐们容我再打一波小广告,我打算用几年时间去做一份关于Java学习、面试、进阶的GitHub项目。
目前刚刚整理好JavaSE基础内容,我将陆续的整理好JavaWeb阶段以及框架知识体系,并添加完善到GitHub中,所以我希望大家能到我的GitHub给上一个Star !现在我的GitHub虽然还没有完善多少技术文章,但是在几个月后,我的GitHub也会陆续成为一个完整的Java学习体系!

记得说好的Star哦!

GitHub地址:https://github.com/Ziphtracks/JavaLearningmanual



目录对于写好一篇文章是一个非常重要的因素,可以通过目录的锚点来实现跳转下文方便阅读与查找。
对此目录CSDN是支持[TOC]目录的,但是还是有很多应用不支持[TOC]目录形式,那就需要创建锚点实现了。但是自己创建锚点又是一件很麻烦、很痛苦的事情怎么办呢?


其实对此锚点目录的生成,目前GitHub中有很多开源的目录生成工具。比如:markdown-toc、GitToc、github-markdown-toc还有Sublime插件MarkDown TOC和在线生成GitHub目录工具等等

但是对此我也并不满意,因为在我使用的过程中,很多工具都特别不稳定,比如:今天可以用,后天可以用,后天甚至以后或某一篇md文章就不能用了,失效了。


所以在此,我推荐一份开源的目录生成工具——gh-md-toc

其实此神器,对MAC和Linux系统比较友好,但是神器的作者提供Windows系统的解决办法。真的是好粥道!因为此神器的GitHub是全英文,也许对英语不好的小伙伴不太友好。所以我教给大家如何下载使用!

gh-md-toc GitHub地址: https://github.com/ekalinin/github-markdown-toc
gh-md-toc 下载地址: https://github.com/ekalinin/github-markdown-toc.go/releases

首先进入到GitHub下载地址,我们可以根据自己的系统来选择下载工具。

在查看GitHub的时候,我们发现该工具是基于GO语言实现。如果你有GO语言的编译环境,可以尝试自己编译,如果没有,可以直接下载编译好的二进制文件。
在这里插入图片描述


gh-md-toc使用教程

声明:我是的Windows系统,没有GO语言的开发环境,所以直接下载的编译好的二进制文件。(gh-md-toc.windows.386.tgz)

  1. 首先,我们发现下载好的文件没有.exe后缀也就是它不是一个可执行文件,所以我们将下载好的文件重命名,加上后缀名.exe,这样我们就可以使用其工具了!
  2. 其次,将README.md文档复制到gh-md-toc.exe的根目录下,当然也可以将工具移动到README.md文档所在文件夹中。
  3. 然后,我们按住Shift键右键单击文件夹空白处,如下操作
    在这里插入图片描述
  4. 打开Powershell窗口后,直接键入代码生成目录,这时候我们需要稍等一会才会生成!(注意:如果出现连接关闭,没有生成目录的情况,多试两次就ok!)
./gh-md-toc.exe README.md
  1. 然后我们将生成的目录粘贴复制到该README.md文件中,其目录就是可以锚点跳转的目录了!(注意:Table头和尾不用复制即可!)
    在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/weixin_44170221/article/details/106402376