---
sidebarDepth: 0  //吐槽：这里设置0无效！只能设置1或2！
---



![](../.vuepress/public/name.png)

# 简介
--------------------
[![vuepress](https://img.shields.io/badge/vuepress-1.0.2-brightgreen.svg) ](https://github.com/vuejs/vuepress)[![element-ui](https://camo.githubusercontent.com/be59cf65edb533614bdaee07bc8edae883a70978/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f656c656d656e742d2d75692d322e372e302d627269676874677265656e2e737667) ](https://github.com/ElemeFE/element)
[![vssue](https://img.shields.io/badge/vssue-1.0.2-brightgreen.svg) ](https://github.com/meteorlxy/vssue)[![vue--highlight](https://img.shields.io/badge/vue--highlight-2.2.0-brightgreen.svg) ](https://github.com/metachris/vue-highlightjs)

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

![](../.vuepress/public/doc.gif)

**如果你喜欢这个项目欢迎[star!](https://github.com/1011cat/shotCat_doc)或者有任何使用问题和bug，欢迎提出[issue和pr](https://github.com/1011cat/shotCat_doc/issues)**

 - [Github地址](https://github.com/1011cat/shotCat_doc)
 - [演示地址](https://1011cat.github.io)
 - [我的个人博客地址：shotcat.com](http://www.shotcat.com)
 - [我的掘金账户](https://juejin.im/user/59b7940d5188257e82675bc0)

 <baseComponent-star></baseComponent-star>


