熟悉Github的同學(xué)可能知道創(chuàng)建一個(gè)Repo，通常都會(huì)生成一個(gè)README.md。好的README能增加代碼的可閱讀性。另外通常也可以將README作為開發(fā)文檔。而這個(gè)README本身是遵循Markdown語(yǔ)法的，但是Markdown本身并沒(méi)有絕對(duì)標(biāo)準(zhǔn)，Github的渲染方式與一些常用博客渲染方式不相同，導(dǎo)致在使用時(shí)有些麻煩。這里推薦一個(gè)Github上的教程。
事實(shí)上大部分和普通Markdown還是類似的，但是目錄的語(yǔ)法差別蠻大，剛好對(duì)于筆者而言，最近需要在Github上文檔上建立目錄來(lái)使用，但是又不想寫GFM的語(yǔ)法。這個(gè)時(shí)候剛好搜索到了一些可以用的開源代碼。這里簡(jiǎn)單介紹一個(gè)目前使用的方法。
1 Github+百度搜索結(jié)果
事實(shí)上解決方案還蠻多的（Github大法好）。
當(dāng)時(shí)還在百度上搜索了下，找到了這個(gè)方案。
2 解決方案：gh-md-toc
后面發(fā)現(xiàn)了gh-md-toc這個(gè)神器。
但是這個(gè)東西在Mac和Linux很友好，windows似乎不那么友好。不過(guò)這里也給了windows的解決方案。
就是github-markdown-toc.go。
github-markdown-toc.go Github地址
如果你有GO語(yǔ)言（又是你）的編譯環(huán)境，可以嘗試自己編譯，如果沒(méi)有，可以直接下載編譯好的二進(jìn)制文件。
下載下來(lái)之后，發(fā)現(xiàn)沒(méi)有后綴名無(wú)法識(shí)別，實(shí)際上這是個(gè)exe文件，所以只需要暴力地在后面加上.exe就可以開始愉快使用了。
首先將README.md文檔復(fù)制到gh-md-toc.exe的根目錄下。
接著按住shift鍵同時(shí)右擊。
打開Powershell窗口后，直接鍵入。
./gh-md-toc.exe README.md
接下來(lái)只需將這段話復(fù)制粘貼到README.md里面即可。
