工具清单 | |||||||||
文档开发工具调研: | |||||||||
工具类型 | 标记语法 | 工具 | 支持平台 | 源文件形式 | 交付形式 | 是否支持文档组织 | 发布对中文的支持 | 说明 | 用户 |
非标记类 | word | Office Word | Window、Mac | docx、doc | word、pdf | 是 | 支持 | 无使用门槛,但需要花时间在格式处理上 | 各公司 |
标记语言类 | markdown | gitbook | Window、Linux | md | pdf、在线html | 是 | 支持 | 由于使用markdow语法,对复杂格式(如复杂表格、图片标题)等支持不足。 源文件可托管在gitbook或github上,可将文档发布到指定域名下。Gitbook本身不提供版本控制,而且客户端工具使用体验较差。 | 微软Azure的所有文档采用markdown并托管在github上 |
showdoc | 基于浏览器,平台无关 | md | 在线html | 是 | 支持 | 主要用于多人协作开发接口文档、数据字典文档等,但不能导出到本地,源文件在服务端(支持云模式和私有服务器模式)。 | 小型的互联网公司 | ||
typora+pandoc | Window | md | md、html、pdf、word | 支持,但缺少导航 | 通过pandoc命令导出中文(支持指定语言属性),但依然会有乱码 | typora原生仅支持md格式,通过pandoc可以实各种格式之间的转换 | 无相关数据 | ||
reStructuredText | Sphinx | Linux | rst | html、manual pages(man 文档)、LaTex(可打印pdf) | 是 | 支持 | 相比markdown支持更多的格式,但目前用于Python项目 | 百度Paddle、Python开发者 | |
asciidoctor | asciidockor | Linux | adoc | pdf、本地html | 是 | 未测试 | 安装过程较麻烦。命令式管理,可以使用Linux上的各文本编辑器进行内容写作。 语法与markdow类型,但支持更复杂的格式控制。 | Redhat, Transwrap, openstack, citrusframework | |
AsciidocFX | Window/Linux/MAC | adoc | pdf、本地html、EPUB、Mobi | 是 | 可以指定语言属性 | 易安装和使用,可以快速上手。 | 无相关数据 | ||
需求:1、支持文档组织;2、支持pdf格式和html格式;3、导出的html与pdf需要支持导航 | |||||||||
结论:通过对各工具比较,AsciidocFX能满足上述需求。 其它说明:在样式控制上,基于标记类语言的工具都是要弱于word的。在支持window的工具中,有gitbook和asciidocFX,但gitbook是在github托管的,而且不能提供本地的html;相对而言,asciidocFX比较满足我们的需求,语法简单,支持pdf以及本地html,同时可以构建出结构良好的导航。 |
文档开发工具调研总结
最新推荐文章于 2019-06-01 21:22:40 发布