你還在爲生成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頭和尾不用複製即可!)
    在這裏插入圖片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章