美文网首页Mac小推车
快速生成Github README.md的目录

快速生成Github README.md的目录

作者: G小调的Qing歌 | 来源:发表于2018-03-19 20:37 被阅读1628次

    熟悉Github的同学可能知道创建一个Repo,通常都会生成一个README.md。好的README能增加代码的可阅读性。另外通常也可以将README作为开发文档。而这个README本身是遵循Markdown语法的,但是Markdown本身并没有绝对标准,Github的渲染方式与一些常用博客渲染方式不相同,导致在使用时有些麻烦。这里推荐一个Github上的教程。

    GFM教程

    GFM教程博客地址

    事实上大部分和普通Markdown还是类似的,但是目录的语法差别蛮大,刚好对于笔者而言,最近需要在Github上文档上建立目录来使用,但是又不想写GFM的语法。这个时候刚好搜索到了一些可以用的开源代码。这里简单介绍一个目前使用的方法。

    1 Github+百度搜索结果

    事实上解决方案还蛮多的(Github大法好)。

    当时还在百度上搜索了下,找到了这个方案。

    ghtoc Github地址(pyhon)

    ghtoc博客

    2 解决方案:gh-md-toc

    后面发现了gh-md-toc这个神器。

    gh-md-toc Github地址

    但是这个东西在Mac和Linux很友好,windows似乎不那么友好。不过这里也给了windows的解决方案。

    就是github-markdown-toc.go。

    github-markdown-toc.go Github地址

    如果你有GO语言(又是你)的编译环境,可以尝试自己编译,如果没有,可以直接下载编译好的二进制文件。

    二进制文件

    下载下来之后,发现没有后缀名无法识别,实际上这是个exe文件,所以只需要暴力地在后面加上.exe就可以开始愉快使用了。

    首先将README.md文档复制到gh-md-toc.exe的根目录下。

    接着按住shift键同时右击。


    打开Powershell窗口后,直接键入。

    ./gh-md-toc.exe README.md
    

    接下来只需将这段话复制粘贴到README.md里面即可。

    相关文章

      网友评论

        本文标题:快速生成Github README.md的目录

        本文链接:https://www.haomeiwen.com/subject/jfqmqftx.html