古老的榕树

Markdown 写接口文档不错

发表 2016-08-04 21:02 阅读(4083)

一直使用 Windows 作为开发环境,有一天切换到 OSX 有点不适应,另外发现使用 word 写接口文档, 有点后悔,OSX 下office 难用不说,开始要找合适的代替品也有点困难,干脆寻找另类的产品试试,要求不高,就是写一些 标题 正文 和表格,有些示例,偶尔加点代码。


这些要求也许直接写 html 比较好,但总不能上 sublime text 吧,有点太原始了,想来想去,最合适的工具应该是 markdown 了,写法很简单,码农基本没有学习成本,可以导出 html,所谓跨平台性相当好,如果需要 pdf 也是轻而易举的。


市面上哪个markdown 工具比较好用呢,最终选择了 Haroopad 和 Typora,写文档的时候,我喜欢使用 Haroopad ,最后再使用 Typora 导出 pdf,导出来的 pdf 带目录,非常好。


说说两者的优缺点,本身这两个软件都可以独立写文档,可惜两者都存在一个缺点,Haroopad 同时有源码和预览模式,即时显示 html 效果,只可以导出 html 文件,不支持直接导出 pdf 文件,但可以使用打印导出 pdf,或依赖浏览器打开 html 再导出 pdf。


而 Typora 也同样存在一个缺点,就是只能使用一种模式,一就是源码模式,不然就是预览模式,两者不能同时开启,不过它做的很简洁,隐形特征很好,能直接导出 PDF 文档,还带目录的。



Donate

如果文章对您有帮助,请使用手机支付宝扫描二维码,捐赠X元,作者离不开读者的支持!