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/。注意，第一个一级标题会被无视，因为要作为文档标题嘛。

转载于:https://www.cnblogs.com/zhengxiaoyao0716/p/5914917.html