简介

qw_doc能帮你快速构建属于自己的组件库文档，它基于vuepress实现。它仿照了element-ui文档，实现了组件展示，代码显示，在线运行，api表格展示，文档版本切换，支持评论等。它可以帮助你从0快速搭建组件文档原型，它已经默认帮你做好所有你需要的配置工作，做到真正的开箱即用。

如果你喜欢这个项目欢迎star!或者有任何使用问题和bug，欢迎提出issue和pr

• Github地址
• 演示地址
• 我的个人博客地址：idearyou.cn

安装

克隆项目
git clone https://github.com/qw7575/vue-qw-doc.git

进入项目目录
cd qw_doc

安装依赖
npm install

建议不要直接使用 cnpm 安装依赖，会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题
npm install --registry=https://registry.npm.taobao.org

启动服务
npm run dev

浏览器访问 http://localhost:6868

项目结构目录说明

|-- qw_doc
    |-- LICENSE
    |-- deploy.sh   //用于自动部署
    |-- package-lock.json
    |-- package.json
    |-- docs
    |   |-- README.md   //文档首页配置
    |   |-- .vuepress   //用于存放全局的配置、组件、静态资源等。
    |   |   |-- config.js   //文档配置文件
    |   |   |-- enhanceApp.js   //应用级别的配置 其实就是引入文档需要用到的第三方插件
    |   |   |-- components  //该目录中的 Vue 组件将会被自动注册为全局组件
    |   |   |   |-- baseComponent   //文档会用到的全局公共组件
    |   |   |   |   |-- apiTable.vue    //组件的参数表格
    |   |   |   |   |-- codeBox.vue     //包裹示例的组件
    |   |   |   |   |-- star.vue    //底部彩蛋组件
    |   |   |   |-- demo   //组件示例 
    |   |   |       |-- qwButton   //存放button组件相关示例
    |   |   |           |-- qwButton.vue
    |   |   |-- dist    //存放打包后的文件
    |   |   |   
    |   |   |-- public  //静态资源目录
    |   |   |   |-- favicon.jpeg
    |   |   |   |-- name.png
    |   |   |-- styles  //用于存放样式相关的文件
    |   |       |-- index.styl  //将会被自动应用的全局样式文件，会生成在最终的 CSS 文件结尾，具有比默认样式更高的优先级
    |   |       |-- palette.styl    //用于重写默认颜色常量，或者设置新的 stylus 颜色常量
    |   |-- components  //存放组件文档要用到的markdown
    |   |   |-- README.md
    |   |   |-- 1.0 //1.0 版本的文档 如果不需要版本管理，直接删除1.0这层文件夹即可
    |   |   |   |-- README.md
    |   |   |   |-- qwButton.md
    |   |   |-- 2.0 //2.0 版本的文档
    |   |       |-- README.md
    |   |       |-- qwButton.md
    |   |-- guide   //使用说明的文件夹
    |       |-- introduction.md
    |       |-- quickStart.md
    |-- src //存放你自己的ui组件库
        |-- index.js
        |-- components
            |-- qwButton
                |-- qwButton.vue

快速开始

step1

将自己的组件库放到根目录上，然后在docs/.vuepress/enhanceApp.js进行配置

//docs/.vuepress/enhanceApp.js

//引入你的组件库 确保你的组件库index文件有install方法
//如果不会，没关系，src目录里自带一个简单组件库示例，可供参考
import Qw from '../../src/index'

export default ({
    Vue, // VuePress 正在使用的 Vue 构造函数
    options, // 附加到根实例的一些选项
    router, // 当前应用的路由实例
    siteData // 站点元数据
  }) => {
    Vue.use(Qw)    
  }

然后配置你的侧边栏路径，详细配置可以直接查看docs/.vuepress/components/config.js 内的注释。

// docs/.vuepress/components/config.js

//这里配置的是button组件页面的路径
sidebar:{
    '/components/2.0/':[
        {
            title: '基础组件',   // 必要的 配置侧边栏名称
            path: '', 
            collapsable: false, // 可选的, 右侧侧边栏是否展开,默认值是 true
            // 如果组件很多时，建议将children配置单独放到一个js文件中，然后进行引入
            children: [
                {
                    title:'Button 按钮',
                    path: 'assembly/basic/qwButton', //在项目中对应的路径是 docs/components/2.0/assembly/basic/qwButton.md
                }]
        }
    ]
},

step2

现在你已经可以开始编写自己的组件文档了，这里先编写一个组件展示示例：以我的qw-button为例

// docs/.vuepress/components/demo/qwButton.vue

<template>
    <!-- 注意这段代码会放入slot里，所以必须再包裹一层div，否则会解析报错 -->
    <div>
        <qw-button text="default"></qw-button>
        <qw-button text="primary" type="primary"></qw-button>
        <qw-button text="success" type="success"></qw-button>
        <qw-button text="info" type="info"></qw-button>
        <qw-button text="warning" type="warning"></qw-button>
        <qw-button text="danger" type="danger"></qw-button>
        <qw-button text="text" type="text"></qw-button>
    </div>
</template>

<script>
    export default {
    }
</script>

step3

在上面配置好的路径里docs/components/2.0/qwButton.md，创建markdown文件。接着就可以愉快地编写button组件页面！

// docs/components/2.0/assembly/basic/qwButton.md

---
title: 2.0 Button 按钮
---

<!-- baseComponent-codeBox 组件即为.vuepress/components/baseComponent/codeBox文件，vuepress会默认把它解析为`baseComponent-codeBox`组件，这里我们如下对代码进行包裹，具体功能可以查看codeBox注释和页面效果 -->
<baseComponent-codeBox title="按钮类型" description="按钮类型通过设置type为primary、success、info、warning、danger、text创建不同样式的按钮，不设置为默认样式。" onlineLink="http://idearyou.cn/qw">

    <!-- 同理demo-qwButton-qwButton即为我们step2编写的示例组件 -->
  <demo-qwButton-qwButton></demo-qwButton-qwButton>

    <!-- 这里highlight-code为引入的第三方代码高亮组件，里面包裹的就是上面示例组件的代码 -->
  <highlight-code slot="codeText" lang="vue">
    <template>
      <div>
        <qw-button text="default"></qw-button>
        <qw-button text="primary" type="primary"></qw-button>
        <qw-button text="success" type="success"></qw-button>
        <qw-button text="info" type="info"></qw-button>
        <qw-button text="warning" type="warning"></qw-button>
        <qw-button text="danger" type="danger"></qw-button>
        <qw-button text="text" type="text"></qw-button>
      </div>
    </template>
    <script>
        export default {
        }
    </script>
  </highlight-code>
</baseComponent-codeBox>

<!-- 组件的参数表格,这里我没有使用自带的markdown表格，因为太丑，样式不好修改，有时参数描述较少时，不能自动撑满一行，所以自己写了一个组件；titile为表格标题，tableHead为表头，tableBody为具体参数设置，并且支持el-table的table参数 -->
<baseComponent-apiTable
  title="Table Attributes"
  :tableHead = "tableHead"
  :tableBody = "tableBody">
</baseComponent-apiTable>

<!-- Vssue为引入的评论插件 -->
<Vssue title="Vssue Demo" />

<!-- 其实在vuepress里的每个.md其实和.vue很像的，你基本可以按照vue组件模式来写 -->
<script>
    // 基本上和写vue一样
  export default {
    data() {
      return {
          //表头为字符串，写法和md一样，中间以`|`间隔就行
        tableHead:`参数 | 说明 | 类型 | 可选值 | 默认值`,
            //表格为数组，其中每一项为字符串，代表每一行要展示的数据，写法也和md一样，中间以`|`间隔就行
        tableBody: [
          `size | 尺寸 | String | medium / small / mini | —`,
          `type |	类型 | string |	primary / success / warning / danger / info / text | —`
        ],
      }
    },

  }
</script>

<!-- 和vue一样，也可以设置样式，并且这里style样式只对当前md有效，不需要加上scoped -->
<style>

</style>

至此，你已经完成了一个简单的button组件展示，概括来说就是：

1. 配置侧边栏导航
2. 写示例代码
3. 对应的页面md

更详细的配置和说明都在对应代码里。每个代码文件里，都有逐行的注释及防坑说明。

爬坑

• 1、没有demo效果，只有示例代码
• 检查对应md的目录，没问题就重启一下