Skip to content

Commit cbcfcdc

Browse files
committed
docs: update docs
1 parent da1f28f commit cbcfcdc

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Build Status](https://travis-ci.com/Yingkaixiang/vue-component-boilerplate.svg?branch=master) [![Greenkeeper badge](https://badges.greenkeeper.io/Yingkaixiang/vue-component-boilerplate.svg)](https://greenkeeper.io/)
44

5-
一个用于创建 vue 组件的脚手架
5+
一个用于快速创建 vue 组件(库)的脚手架
66

77
在线示例:
88

@@ -26,10 +26,13 @@
2626
- [ ] 支持 图片自动上传至 CDN。
2727
- [x] 支持 使用 Jest 进行单元测试。
2828
- [ ] 支持 移动端调试。
29-
- [ ] 支持 可视化自动测试。
3029
- [x] 支持 快捷功能脚本(如:一键创建组件目录及相关默认文件)。
3130
- [x] 支持 CI/CD。
3231
- [x] travis CI
32+
- [ ] 支持 git commit 工作流
33+
- [ ] 代码风格检测
34+
- [ ] 单元测试
35+
- [ ] commit message 提交规范
3336

3437
## 规范
3538

@@ -39,11 +42,15 @@
3942

4043
## 项目目录
4144

42-
- build 构建脚本
43-
- components 组件
44-
- cjs 全量加载输出目录
45-
- lib 按需加载输出目录
46-
- src 全量导入入口
45+
- .storybook - `storybook` 相关配置
46+
- .vscode - `VSCode` 相关配置
47+
- bin - 辅助构建用的脚本
48+
- build - 构建脚本
49+
- components - 组件
50+
- cjs - 全量加载输出目录
51+
- lib - 按需加载输出目录
52+
- jest - `jest` 相关配置
53+
- src - 全量导入入口
4754

4855
## 如何使用
4956

@@ -112,4 +119,6 @@ module.exports = {
112119

113120
## 为什么不在 .vue 文件中写 css?
114121

115-
组件库本身有一套自己的 CSS 命名规则,保证唯一的命名空间以及可以方便的进行修改。所以 scoped 和 CSS Module 对于组件库来说是没有意义的。但是在 .vue 文件中使用 `<style></style>` 标签的话 `vue-loader` 一定会把相关的 CSS 处理逻辑(如模拟 scoped 特性)打包进最终的文件里。所以采用分离的方式编写 CSS,也能做到组件库样式的统一管理。
122+
组件库本身有一套自己的 CSS 命名规则,保证唯一的命名空间以及可以方便的进行修改。所以 scoped 和 CSS Module 对于组件库来说是没有意义的。但是在 .vue 文件中使用 `<style></style>` 标签的话 `vue-loader` 一定会把相关的 CSS 处理逻辑(如模拟 scoped 特性)打包进最终的文件里。所以采用分离的方式编写 CSS,也能做到组件库样式的统一管理。
123+
124+
> 如果你有什么建议或者想法可以给我发邮件 rubykaikai@gmail.com 来一起探讨哦!~

0 commit comments

Comments
 (0)