markdown 写的文档,在项目组内外分享时不能要求读者也将就着读 markdown,最好还是读网页的友好形式 —— mkdocs 是个不错的选择。
mkdocs 之前,我都是 git push
md 文档后,触发 http server 上的 git pull
,然后利用一些零散的 js 脚本实现 md->html 的动态编译,包括:TOC(目录)、CSS、Theme…… mkdocs 则方便且优雅的完成这一切。
- mkdocs: https://www.mkdocs.org/
- github:https://github.com/mkdocs/mkdocs