Markdown寫接口文檔，自動添加TOC

上回說到，用Impress.js代替PPT來作項目展現。這回換Markdown來作接口文檔好了。（不敢說代替Word，只能說我的感受更爲方便）固然，還要輔之以Git，來方便版本管理。

Markdown基本語法也沒啥好說的，隨便百度一下幾分鐘看懂基本的，20%的知識完成80%的任務嘛，夠了。

關鍵在於，我有些特殊需求，以方便將Markdown做爲接口文檔查看。什麼需求呢？

1. 目錄。這是重中之重。沒有方便的TOC的話，文檔長了，查看起來真是費勁。我理想中的目錄是這樣的：

   • 根據H1（# ）、H2（## ）號標題，自動生成索引，而不是網上其它人的什麼標題都生成索引，弄一堆子亂七八糟的徹底沒有接口文檔的感受了。

   • 這個目錄必定得是浮動在側邊欄的，不能說要查某個接口還得先回到頁首去。

   • 這個目錄還應該是自動摺疊的，當我不須要它時它獲得一側縮着，不能礙事。

2. 表格樣式，必定得是易讀的，字體不能小，分界要明顯，每行顏色要深淺交錯開，表頭顏色要更深。

3. 讀取要方便，不能要求你們都裝一個Markdown閱讀器，否則又成Word了。我要求能直接從瀏覽器打開閱讀。可是也不能說每次都上傳到Github之類的地方去看，麻煩，並且Github也不支持自定義樣式。最重要的是，我並無Github上的私有倉庫。

Ok，就這些需求。我的感受要求不高吧？呵呵，找了半天還真沒找到。因而乎，本身寫了一個咯：https://github.com/zhengxiaoyao0716/MarkedWithToc。

簡單來講，就是一張網頁。把寫好的.md文件拖拽上去，而後按照以上需求生成html預覽自動生成目錄、黑白兩種爲接口文檔優化過的主題，一鍵保存到本地。配合git作版本管理，應該會方便不少。

就這樣，本次不是教程，不是學習筆記，只是一個建議和推廣，給全部追求變化愛折騰的程序猿。懶得進GitHub的，直接打開這個連接便可使用：http://temp.zheng0716.com/MarkedWithToc/。注意，第一個一級標題會被無視，由於要做爲文檔標題嘛。