cca-docs

基于 docsify 生成组件库文档的生成器，支持图片预览、emoji以及代码预览高亮等。

安装

yarn add @cgzair/cca-docs

使用

脚本

打开项目的 package.json 文件，添加以下脚本命令。

"scripts": {
  "docs": "docs",
},

运行此命令，即可打开一个组件库文档服务地址。

npm run docs

可选命令

指定文档目录

指定生成的临时文件目录，默认是.docs:

docs .my-docs

最终默认文档生成临时文件目录为.my-docs。

端口

支持指定预览端口：

docs -p 8888
docs --port 8888

教程

示例

图片预览示例

支持常规图片类型，包括不限于

文件导入示例

demo1

其它

过滤部分文件不生产组件文档说明，在项目根路径创建.docsignore文件夹，写入glob语法文本即可：

**/changelog.md
**/libs/**