总结一下最近学到的编写文档的工具和语法
来源:互联网 发布:java json 大括号转义 编辑:程序博客网 时间:2024/06/15 18:17
第一就是编写本文档用到的语法: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 0
- 总结一下最近学到的编写文档的工具和语法
- 总结一下最近学到的10个JS技巧
- 总结最近学到的东西
- 总结以下最近学到的东西
- JAVA学习日志 最近学到接口和,接口的继承,写个测试一下
- 简单记录一下最近学到的c++内容
- 总结一下最近的生活
- 总结一下最近的体会
- [总结一下]最近的工作
- 05-最近学到的一些知识的总结
- 总结一下最近整合spring4和hibernate4遇到的问题
- 最近学到的小技巧
- 最近学到的android资料
- 简单递推 学到的一些皮毛,总结一下
- 总结一下这几天学习matlab学到的东西
- 文档的编写总结
- 总结一下最近2个多月写的程序
- 总结一下最近使用的easyui
- C/C++21个重点笔记(常考笔试面试点)
- 转:ibatis动态sql
- 取消tableView多余的横线
- phonegap/cordova项目发布android apk
- 运用Eclipse 的Jetty插件直接部署
- 总结一下最近学到的编写文档的工具和语法
- hadoop安全机制
- 【Java】【Fulme】Flume-NG源码阅读之SpoolDirectorySource
- Ibatis动态(dynamic)查询
- 说说Java中的实例初始化器
- 法律导论
- 基于jenkins的增量发布
- 修改LoadRunner自带的示例程序端口号
- 如何判断文件有没有读取到尾部