Vuese自動生成vue元件文檔

1.安裝Vuese

npm i vuese --save-d

2.在根目錄下新增配置檔案 .vueserc

{
  "include": [
    "./components/**/*.vue"
  ],
  "title": "ASui-doc",
  "genType": "docute",
  "outDir": "./docs"
}
           

include：指定建構元件目錄。

title: 文檔名稱

genType: 指定生成的文檔類型，docute 會把vue檔案建構出的所有markdown，整合為一個單頁應用。

outDir：指定文檔輸出目錄，這裡指定為./docs，是為了配和在master分支接入OA Pages。

3.在package.json新增腳本，并啟動。

"scripts": {
    ...
    "build_doc": "npx vuese gen && npx vuese serve --open"
 },
           

運作 npm run build_doc 啟動腳本

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