Vue公共組件文檔維護

在日常開發中，我們不可避免的維護公共組件。我翻遍全網終於找到一個好用的 根據Vue單文件生成文檔的系統。他就是我們今天的主角 Vuese(鏈接指向命令行工具文檔)，如果您心急可以直接跳轉到Vuese官方網站。加下來我將記錄下我使用Vuese的一些過程，供參考。

安裝

我這邊，基本不可能只有一個項目。所以我采用全局安裝的方式來使用 Vuese 的命令航工具。

npm i -g @vuese/cli
## 如果用 yarn 的話
yarn global add @vuese/cli

配置

配置文件放在根目錄下 文件名稱為 vuese.config.js.配置說明請參考官方文檔。

module.exports = {
  genType: "docute",
  title: "預覽文件名",
  include: [
    "path/to/component.vue",
  ],
  outDir: "docs",
}

使用

以下命令，在項目根目錄下執行

更新組件文檔

vuese gen

文檔查看

vuese serve --open