瞎扯淡 有哪些比较好的文档撰写工具

markgeek · 2015年12月25日 · 最后由 gzyunke 回复于 2019年12月12日 · 2896 次阅读

最近在完善我们自己的 Cloud Insight 的文档,初期在用 Gitbook 来做,但是现在感觉太像一本书了,不够直观。像下面这样:

我发现很多的开源项目的文档都做的非常漂亮,比如 dokku 的,我们自己也想做成这样:

请问大家知道这样的文档是用静态网站生成器做出来的,还是说有什么工具专门做这个?

我发现一个http://readme.io/,能做出非常漂亮的文档,可惜只能存储到它那里,如下:

readme.io 很好啊,不放心存它那里吗?

#3 楼 @mars 主要是觉得慢,而且文档内容比较多,本地编辑起来还是比较方便

你可以使用 middleman 来自己做嘛

slate 这种单页式的 API 文档对不熟悉的人是很不友好的,例如 backbone 的文档,当搜索一个关键词,从头跳到尾,实际只想看某个章节的内容。而 gitbook 还是挺不错的,支持多种存档格式(PDF,EPUB),我们的 styleguide 就托管在 gitbook 上,跟 github 对接后,push 就自动编译,省心省事。

#5 楼 @greatghoul @rainchen 已经决定通过 middleman 来做了,之前是以为有现成的 模板套用,找了半天还是没有啊,只能从头开始搭了。

https://easydoc.top 易文档很好用呀,专门写接口文档的

需要 登录 后方可回复, 如果你还没有账号请 注册新账号