快速生成Github README.md的目錄1 Github+百度搜尋結果2 解決方案：gh-md-toc

版權聲明：本文為部落客原創文章，未經部落客允許不得轉載。 https://blog.csdn.net/ESA_DSQ/article/details/79617041

熟悉Github的同學可能知道建立一個Repo，通常都會生成一個README.md。好的README能增加代碼的可閱讀性。另外通常也可以将README作為開發文檔。而這個README本身是遵循Markdown文法的，但是Markdown本身并沒有絕對标準，Github的渲染方式與一些常用部落格渲染方式不相同，導緻在使用時有些麻煩。這裡推薦一個Github上的教程。

GFM教程 GFM教程部落格位址 事實上大部分和普通Markdown還是類似的，但是目錄的文法差别蠻大，剛好對于筆者而言，最近需要在Github上文檔上建立目錄來使用，但是又不想寫GFM的文法。這個時候剛好搜尋到了一些可以用的開源代碼。這裡簡單介紹一個目前使用的方法。

• 1 Github+百度搜尋結果
• 2 解決方案：gh-md-toc

事實上解決方案還蠻多的（Github大法好）。

當時還在百度上搜尋了下，找到了這個方案。

ghtoc Github位址（pyhon） ghtoc部落格

後面發現了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裡面即可。