求帮助文档编写工具

我的问题:
我想找到一个工具,能够像hexo那样用markdown来编写文章,然后生成html文档。
由于项目开发需要编写软件帮助文档(需要在本机打开html页面就能看到),但是不想用office word来写。
目标是想做一个spring、spring boot那样的html文档。
直接试了一下hexo,但是生成的html内容需要部署到服务器才能访问。
各位有什么好工具推荐吗?

spring boot的文档是这样子的:
图片描述

阅读 8.3k
5 个回答

写官方帮助文档最合适的工具就数asciidoc了。相比markdown支持更丰富的格式,甚至连图标都能支持,还支持部分数学公式。相比LaTex要更简单。如果你想书写比markdown更加规范的帮助文档,那么asciidoc可能是你的选择。

和markdown同样属于标记性文档,易学易上手,标记比markdown多,生成的排版更加规范。

如果你只是想生成一个github项目那种README文档的话,可能markdown就足够了,因为它标签足够少,够简单

slate

screenshot-slate.png

使用slate构建api的应用太多了,举个常用的:

Travis CI

最终找到适合我的工具:gitbook

新手上路,请多包涵
撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进
推荐问题