rc-docgen v0.0.5

rc-docgen

react 组件 API 文档生成器

使用

• 1、全局安装 rc-docgen

  npm install rc-docgen -g

• 2、在需要生成文档的项目的根目录执行

  rc-docgen i

生成 docs 目录，该目录为文档文件夹

• 3、在 config.json 中指定需要生成文档的组件目录文件夹

{
  srcDir: 表示组件源代码的根目录，路径相对于脚本文件scripts/create-api-docs
}

• 4、提取组件 API

  npm run docs

• 5、运行

  npm start