0%

文档站点生成工具

写代码总是要维护文档的,最好文档和代码是在一起的。

这时候比较好的解决方案就是Markdown了,然后借助工具自动生成文档站点。

GitBook

这可能是用户量最大的方案了,官方还提供了免费的托管服务,如果你的项目是开源的话可以考虑。但听说官方商业化后对免费用户不是很友好,比如插件或者命令行的支持等等。

官网:https://www.gitbook.com/

image-20200222154308518

docsify

最轻量的解决方案,你只要引用一下它的js文件到你的主页,外加一些配置就可以渲染,这是我个人最喜欢的工具之一。docsify最大的特点是不需要编译,实时渲染Markdown。

官网:https://docsify.js.org/

image-20200222154600499

vuepress

跟GitBook非常相似的,主题和插件也很丰富,不仅可以做文档,还可以做博客。

官网:https://vuepress.vuejs.org/

image-20200222155018511

sphinx

Python文档的最佳搭档,可以识别Python中的方法注释,非常强大。市面上大多数的Python工具的文档都是用它生成的。

官网:https://www.sphinx-doc.org/

image-20200222160704364

欢迎到微信里去当吃瓜群众