4.1.0 • Published 5 years ago
doc-reader v4.1.0
doc-reader
jsdoc3 已经很完美的支持 es6 了,可惜还是不能支持 react 已经 css classes。基于 jsdoc3 通过 jsdoc3 插件和模板的开发,实现以上功能。可以为 bnorth 工具集提供统一的 api 文档生成方案。
起步
bnorth-doc [src] [des] [package] [readme]
- src: 源码路径,默认是
./src
- des: 目标文档生成路径 ,默认是
./docs
- package: package 信息文件 ,默认是
./package.json
- readme: readme 文件路径 ,默认是
./README.md
特性
- 单页面方式速度快
- 支持 react 组件
- 支持 css class
- 支持 es6,友好显示 es 模块
文档
基于该文档生成库的 bnorth 参考文档
LICENSE
MIT