总结一下最近学到的编写文档的工具和语法

第一就是编写本文档用到的语法: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 文件作为配置文档.

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值