本仓库不再维护,更新的内容前往:ZJDoc/DocGuide¶
引言¶
之前总结了一套文档生成、托管和发布的流程:
sphinx文档制作,github远程托管,readthedocs在线发布
不过使用过程中发现sphinx
还有一些不方便,在网上找到另一个文档生成工具MkDocs
,更加适合Markdown
语法编辑
当前完整的操作流程如下:
mkdocs文档制作,github远程托管,readthedocs在线发布
相关链接:
之前总结了一套文档生成、托管和发布的流程:
sphinx文档制作,github远程托管,readthedocs在线发布
不过使用过程中发现sphinx
还有一些不方便,在网上找到另一个文档生成工具MkDocs
,更加适合Markdown
语法编辑
当前完整的操作流程如下:
mkdocs文档制作,github远程托管,readthedocs在线发布
相关链接: