galaxy-vuepress-docs v0.0.2

Vuepress v1 插件

简介

1. 使用自定义 ::: demo 语法，写一遍示例即可自动生成组件示例与代码示例；
2. 支持在md中使用 import 语法；
3. 支持code在线编辑,包括编辑含import的代码，但不支持在编辑页额外import其它的文件

##兼容性 1. 此版本只支持vue2项目

安装

npm install galaxy-vuepress-cli -g --registry=http://120.79.37.227:4873/  

使用

生成vuepress

一键生vuepress配置，安装相关npm包

在您的项目根目录下使用

npx gvuepress init

运行

npm run docs:dev

注意

如果运行时报Vue packages version mismatch，那么需要去package.json里面将不匹配的依赖包锁版本，去掉^或者~版本修饰符

在进行完以上操作后，您即可使用本插件所有功能进行文档开发

在.md 文件中使用以下语法

::: demo

```js
<template>
  <div>
    <p>{{message}}</p>
    <input v-model="message" placeholder="输入"></input>
  </div>
</template>
<script>
  export default {
    data() {
      return {
        message: ''
      }
    }
  };
</script>
```

一键为您所有的组件生成文档

npm run gen:docs

为单个组件生成文档

npm run gen:docs -- -t 'D:\code\CRM\src\components\AddRecords\AddRecords.vue'

发布测试

登录npm

npm adduser --registry http://120.79.37.227:4873
Username: galaxy
Password: Galaxy@20210826
Email: galaxy2021@qq.com

发布测试

npm version patch // 之后需要git push 让代码同步 npm publish --registry http://120.79.37.227:4873