Vue公共组件文档维护

Posted 2020-12-16 lbpeter0911

在日常开发中，我们不可避免的维护公共组件。我翻遍全网终于找到一个好用的 根据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