第一就是编写本文档用到的语法:MarkDown
markdown语法,的确如文档中所说:一朝学会,终生受益。
简单易懂,很容易上手!
API文档编写工具(Raml)
- 需要用到node.js下载,下载之前安装node.js
api-designer(api设计工具)
安装方式:
npm install -g api-designer
api-designer
raml2html(将设计好的Raml转换成Html文档)
安装方式:
npm i -g raml2html
使用方法:
raml2html example.raml > example.html
mkdocs(详情看文档吧)
MkDocs 是一个用于创建项目文档的 快速, 简单 , 完美华丽 的静态站点生成器. 文档源码使用 Markdown 来撰写, 用一个 YAML 文件作为配置文档.