Vuese自动生成vue组件文档

1.安装Vuese

npm i vuese --save-d

2.在根目录下新增配置文件 .vueserc

{
  "include": [
    "./components/**/*.vue"
  ],
  "title": "ASui-doc",
  "genType": "docute",
  "outDir": "./docs"
}
1
2
3
4
5
6
7
8

include：指定构建组件目录。

title: 文档名称

genType: 指定生成的文档类型，docute 会把vue文件构建出的所有markdown，整合为一个单页应用。

outDir：指定文档输出目录，这里指定为./docs，是为了配和在master分支接入OA Pages。

3.在package.json新增脚本，并启动。

"scripts": {
    ...
    "build_doc": "npx vuese gen && npx vuese serve --open"
 },
1
2
3
4

运行 npm run build_doc 启动脚本

Vuese使用指南：https://vuese.org/zh/cli/