在项目集成阶段中,接口文档是不可避免的,以往的我使用word编辑器编写接口文档,虽然word使用不是很熟练,但是只要在网上下载模板或者自己花时间搞定一个文档格式
基本能一劳永逸。但是还是会有很多问题存在,比如,docx在git上是不能记录版本的,如果你想使用docx作为借口文档,并且还有接口文档版本化这么一个过程,推荐使用markdown,目前我在使用一款markdown工具,叫Typora。
地址:http://www.typora.io/
这款markdown工具首先是小巧,但是功能缺很强大,支持markdown的标准语法,同时这款软件还支持动态预览功能,一键预览,一键源码,感觉上很爽,这款软件可以对
图片、代码、有序/无序列表、代码块、数学公式和目录都支持,你想要的基本都有。
这款软件还可以自定义CSS,感觉默认的样式不美观,动手自己修改,有道是,别人的不如自己的,看不惯你就换。
让我最心仪的功能还是它可以转换成PDF,这样更方便我提供给客户,并且能做版本控制和记录。
不太爽的是mac和windows下,导出功能丢了好多。
有需求的人要markdown,可以尝试一下Typora。
markdown的基本语法:http://www.appinn.com/markdown/