先不多说,上图:
初步使用,感觉还不错,因为其使用的运行环境是 Gem,所以需要安装 Ruby 相关的环境。安装可以参考链接:https://my.oschina.net/lsjcoder/blog/1583072
常用的命令表如下:
参数 | 含义 |
---|---|
— 或 空 | 需要生成文档的文件或者目录,也可以是一个集合 |
–output | 文档存放的目录 |
–config | 配置文件路径 |
–encoding | 文档编码方式 |
–exclude | 不生成文档的目录或文件,可以是一个集合 |
–title | 文档标题 |
–footer | 文档标尾 |
–head-html | 文档页面的head中需要添加的内容 |
–body-html | 文档页面的body中需要添加的内容 |
–css | 额外添加的样式 |
–welcome | 欢迎页面 |
–guides | 向导配置 |
–examples | 示例配置 |
–categories | 分类配置 |
–images | 图片路径配置 |
–tags | 自定义标签 |
–examples-base-url | 示例文件的基础路径 |
–help | 查看命令帮助 |
–version | 查看当前版本 |
随着 JavaScript 在越来越多的工程中扮演越来越重要的角色,文档的完善越来越重要,同时也开始约束 JSer 慢慢开始学习工程化,系统化的编写代码。开始自我改造吧。