deep-ui

dee-ui

介绍

每家公司/每个团队，在持续协作维护项目的过程中，总会产出一些较为通用性的组件，或者 UI 会设计一些样式组件。

但是如果放在项目里的话，大家其实都不会去翻文件看，那这时候有个文档记录一下这些通用组件的话，会让大家协作的意愿更强烈。:fire:

更重要的是，可以提高代码的复用性, 打包编译发布到 npm 上，告别多项目的复制粘贴。 :beers:

使用及其简单的方式 (vue-cli3 以及 vuepress) 维护 团队/个人的 组件库。:tada::tada::tada:

Features

• 代码打包 📦 npm lib 即可
• 代码即文档，代码里面加注释即可解决文档问题
• yarn new 交互式创建新组件文件，不用再繁琐的写 template
• vuepress 组件更新注释文档预览实时更新
• 单独打包每个组件 css
• 自动生成 release logs
• 添加 eslint

Project setup

由于 vuepress 依赖的是 core-js 是 2.x 版本，而 vue-cli3 中依赖的是 3.x 版本.

所以 vuepress 需要进行全局安装。

npm i -g vuepress core-js@2.6.11

git clone 

yarn install

yarn docs:dev // 启动开发模式

yarn new // 创建新组件

参考链接

• https://github.com/vue-styleguidist/vuepress-plugin-live
• https://github.com/BuptStEve/markdown-it-vuese
• https://github.com/shuidi-fed/vuese
• https://markdown-it.github.io/markdown-it/
• https://github.com/koca/vue-prism-editor
• https://juejin.im/post/5dd234635188254a1f44646a#heading-27
• https://segmentfault.com/a/1190000015261753

Contributors ✨

Thanks goes to these wonderful people (emoji key):

cjfff 📖 🐛 💡 🤔 🚧 💻

This project follows the all-contributors specification. Contributions of any kind welcome!