Skip to content

Commit f917743

Browse files
authored
Add allcontributors reboot to generate list of contributors (DevCloudFE#43)
* chore: add all-contributors reboot * docs: update README.md 处理标题级别
1 parent 2d8093d commit f917743

File tree

4 files changed

+123
-26
lines changed

4 files changed

+123
-26
lines changed

.all-contributorsrc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"projectName": "vue-devui",
3+
"projectOwner": "DevCloudFE",
4+
"repoType": "github",
5+
"repoHost": "https://github.com",
6+
"files": [
7+
"README.md"
8+
],
9+
"imageSize": 100,
10+
"commit": true,
11+
"commitConvention": "gitmoji",
12+
"contributors": [
13+
{
14+
"login": "kagol",
15+
"name": "Kagol",
16+
"avatar_url": "https://avatars.githubusercontent.com/u/9566362?v=4",
17+
"profile": "https://juejin.cn/user/712139267650141",
18+
"contributions": [
19+
"maintenance",
20+
"code",
21+
"doc"
22+
]
23+
}
24+
],
25+
"contributorsPerLine": 7
26+
}

README.md

Lines changed: 41 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
<p align="center">
2+
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
3+
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
4+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
25
<a href="https://devui.design/home" target="_blank" rel="noopener noreferrer">
36
<img alt="DevUI Logo" src="https://github.com/DevCloudFE/vue-devui/raw/dev/packages/devui-vue/public/logo.svg" width="180" style="max-width:100%;">
47
</a>
@@ -8,7 +11,7 @@ Vue DevUI 是 Vue3 版本的 DevUI 组件库,基于 [https://github.com/devclo
811

912
DevUI 官方网站:[https://devui.design](https://devui.design)
1013

11-
# 当前状态: Beta
14+
## 当前状态: Beta
1215

1316
该项目还处于孵化和演进阶段,欢迎大家参与到 Vue DevUI 项目的建设中来!🎉🎉
1417

@@ -20,9 +23,9 @@ DevUI 官方网站:[https://devui.design](https://devui.design)
2023

2124
[贡献指南](https://github.com/DevCloudFE/vue-devui/wiki/%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)
2225

23-
# 快速开始
26+
## 快速开始
2427

25-
## 1 安装依赖
28+
### 1 安装依赖
2629

2730
```
2831
yarn(推荐)
@@ -32,7 +35,7 @@ or
3235
npm i
3336
```
3437

35-
## 2 启动
38+
### 2 启动
3639

3740
```
3841
yarn dev(推荐)
@@ -42,11 +45,11 @@ or
4245
npm run dev
4346
```
4447

45-
## 3 访问
48+
### 3 访问
4649

4750
[http://localhost:3000/](http://localhost:3000/)
4851

49-
## 4 生产打包
52+
### 4 生产打包
5053

5154
```
5255
yarn build(推荐)
@@ -56,15 +59,15 @@ or
5659
npm run build
5760
```
5861

59-
# 使用 Vue DevUI
62+
## 使用 Vue DevUI
6063

61-
## 1. 安装
64+
### 1. 安装
6265

6366
```
6467
yarn add vue-devui
6568
```
6669

67-
## 2. 全量引入
70+
### 2. 全量引入
6871

6972
`main.ts`文件中编写以下代码:
7073
```
@@ -81,7 +84,7 @@ createApp(App)
8184
.mount('#app')
8285
```
8386

84-
## 3. 按需引入
87+
### 3. 按需引入
8588

8689
除了全量引入,我们也支持单个组件按需引入。
8790

@@ -101,7 +104,7 @@ createApp(App)
101104
.mount('#app')
102105
```
103106

104-
## 4. 配置自动按需引入`unplugin-vue-components`(推荐)
107+
### 4. 配置自动按需引入`unplugin-vue-components`(推荐)
105108

106109
配置`unplugin-vue-components`插件可以无需引入Vue DevUI就可以直接按需使用其中的组件,具体使用方式如下:
107110

@@ -126,21 +129,21 @@ export default defineConfig({
126129

127130
配置了以上插件,就可以直接在代码中使用`Vue DevUI`的组件,而无需在`main.ts`文件中引入`Vue DevUI`
128131

129-
## 5. 使用
132+
### 5. 使用
130133

131134
```
132135
<template>
133136
<d-button>确定</d-button>
134137
</template>
135138
```
136139

137-
# 图标库
140+
## 图标库
138141

139142
图标库推荐使用[DevUI图标库](https://devui.design/icon/ruleResource),也可以使用第三方图标库,比如:iconfont。
140143

141-
## 使用DevUI图标库
144+
### 使用DevUI图标库
142145

143-
### 安装
146+
#### 安装
144147

145148
```
146149
yarn add @devui-design/icons(推荐)
@@ -150,20 +153,40 @@ or
150153
npm i @devui-design/icons
151154
```
152155

153-
### 引入
156+
#### 引入
154157

155158
`main.ts`文件中,编写以下代码:
156159

157160
```
158161
import '@devui-design/icons/icomoon/devui-icon.css'
159162
```
160163

161-
### 使用
164+
#### 使用
162165

163166
```
164167
<d-icon name="love" color="red"></d-icon>
165168
```
166169

167-
# License
170+
## Contributors ✨
171+
172+
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
173+
174+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
175+
<!-- prettier-ignore-start -->
176+
<!-- markdownlint-disable -->
177+
<table>
178+
<tr>
179+
<td align="center"><a href="https://juejin.cn/user/712139267650141"><img src="https://avatars.githubusercontent.com/u/9566362?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kagol</b></sub></a><br /><a href="#maintenance-kagol" title="Maintenance">🚧</a> <a href="https://github.com/DevCloudFE/vue-devui/commits?author=kagol" title="Code">💻</a> <a href="https://github.com/DevCloudFE/vue-devui/commits?author=kagol" title="Documentation">📖</a></td>
180+
</tr>
181+
</table>
182+
183+
<!-- markdownlint-restore -->
184+
<!-- prettier-ignore-end -->
185+
186+
<!-- ALL-CONTRIBUTORS-LIST:END -->
187+
188+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
189+
190+
## License
168191

169192
[MIT](https://github.com/DevCloudFE/vue-devui/blob/dev/LICENSE)

package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,19 @@
1111
"stylelint": "stylelint --fix \"{packages}/**/*.{scss,css}\""
1212
},
1313
"devDependencies": {
14-
"lerna": "^4.0.0",
15-
"husky": "^7.0.4",
1614
"@ls-lint/ls-lint": "^1.10.0",
15+
"all-contributors-cli": "^6.20.0",
1716
"esbuild-register": "^2.6.0",
1817
"eslint": "^7.28.0",
1918
"eslint-plugin-import": "^2.24.2",
2019
"eslint-plugin-vue": "^7.11.1",
20+
"husky": "^7.0.4",
21+
"lerna": "^4.0.0",
22+
"lint-staged": "^11.0.0",
2123
"stylelint": "^13.13.1",
2224
"stylelint-config-recommended-scss": "^4.3.0",
2325
"stylelint-config-standard": "^22.0.0",
24-
"stylelint-scss": "^3.20.1",
25-
"lint-staged": "^11.0.0"
26+
"stylelint-scss": "^3.20.1"
2627
},
2728
"workspaces": [
2829
"packages/*"

yarn.lock

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1011,6 +1011,13 @@
10111011
dependencies:
10121012
regenerator-runtime "^0.13.4"
10131013

1014+
"@babel/runtime@^7.14.6", "@babel/runtime@^7.7.6":
1015+
version "7.16.5"
1016+
resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.16.5.tgz#7f3e34bf8bdbbadf03fbb7b1ea0d929569c9487a"
1017+
integrity sha512-TXWihFIS3Pyv5hzR7j6ihmeLkZfrXGxAr5UfSl8CHf+6q/wpiYDkUau0czckpYG8QmnCIuPpdLtuA9VmuGGyMA==
1018+
dependencies:
1019+
regenerator-runtime "^0.13.4"
1020+
10141021
"@babel/template@^7.0.0", "@babel/template@^7.12.7", "@babel/template@^7.16.0", "@babel/template@^7.3.3":
10151022
version "7.16.0"
10161023
resolved "https://registry.npmjs.org/@babel/template/-/template-7.16.0.tgz#d16a35ebf4cd74e202083356fab21dd89363ddd6"
@@ -3186,6 +3193,22 @@ algoliasearch@^4.0.0:
31863193
"@algolia/requester-node-http" "4.11.0"
31873194
"@algolia/transporter" "4.11.0"
31883195

3196+
all-contributors-cli@^6.20.0:
3197+
version "6.20.0"
3198+
resolved "https://registry.yarnpkg.com/all-contributors-cli/-/all-contributors-cli-6.20.0.tgz#9bc98dda38cb29cfe8afc8a78c004e14af25d2f6"
3199+
integrity sha512-trEQlL1s1u8FSWSwY2w9uL4GCG7Fo9HIW5rm5LtlE0SQHSolfXQBzJib07Qes5j52/t72wjuE6sEKkuRrwiuuQ==
3200+
dependencies:
3201+
"@babel/runtime" "^7.7.6"
3202+
async "^3.0.1"
3203+
chalk "^4.0.0"
3204+
didyoumean "^1.2.1"
3205+
inquirer "^7.0.4"
3206+
json-fixer "^1.5.1"
3207+
lodash "^4.11.2"
3208+
node-fetch "^2.6.0"
3209+
pify "^5.0.0"
3210+
yargs "^15.0.1"
3211+
31893212
ansi-colors@^4.1.1:
31903213
version "4.1.1"
31913214
resolved "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz#cbb9ae256bf750af1eab344f229aa27fe94ba348"
@@ -3352,6 +3375,11 @@ async-validator@^4.0.2:
33523375
resolved "https://registry.npmjs.org/async-validator/-/async-validator-4.0.7.tgz#034a0fd2103a6b2ebf010da75183bec299247afe"
33533376
integrity sha512-Pj2IR7u8hmUEDOwB++su6baaRi+QvsgajuFB9j95foM1N2gy5HM4z60hfusIO0fBPG5uLAEl6yCJr1jNSVugEQ==
33543377

3378+
async@^3.0.1:
3379+
version "3.2.2"
3380+
resolved "https://registry.yarnpkg.com/async/-/async-3.2.2.tgz#2eb7671034bb2194d45d30e31e24ec7e7f9670cd"
3381+
integrity sha512-H0E+qZaDEfx/FY4t7iLRv1W2fFI6+pyCeTw1uN20AQPiwqwM6ojPxHxdLv4z8hi2DtnW9BOckSspLucW7pIE5g==
3382+
33553383
asynckit@^0.4.0:
33563384
version "0.4.0"
33573385
resolved "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79"
@@ -4385,6 +4413,11 @@ diacritics@^1.3.0:
43854413
resolved "https://registry.npmjs.org/diacritics/-/diacritics-1.3.0.tgz#3efa87323ebb863e6696cebb0082d48ff3d6f7a1"
43864414
integrity sha1-PvqHMj67hj5mls67AILUj/PW96E=
43874415

4416+
didyoumean@^1.2.1:
4417+
version "1.2.2"
4418+
resolved "https://registry.yarnpkg.com/didyoumean/-/didyoumean-1.2.2.tgz#989346ffe9e839b4555ecf5666edea0d3e8ad037"
4419+
integrity sha512-gxtyfqMg7GKyhQmb056K7M3xszy/myH8w+B4RT+QXBQsvAOdc3XymqDDPHx1BgPgsdAA5SIifona89YtRATDzw==
4420+
43884421
diff-sequences@^26.6.2:
43894422
version "26.6.2"
43904423
resolved "https://registry.npmjs.org/diff-sequences/-/diff-sequences-26.6.2.tgz#48ba99157de1923412eed41db6b6d4aa9ca7c0b1"
@@ -5725,7 +5758,7 @@ init-package-json@^2.0.2:
57255758
validate-npm-package-license "^3.0.4"
57265759
validate-npm-package-name "^3.0.0"
57275760

5728-
inquirer@^7.3.3:
5761+
inquirer@^7.0.4, inquirer@^7.3.3:
57295762
version "7.3.3"
57305763
resolved "https://registry.npmjs.org/inquirer/-/inquirer-7.3.3.tgz#04d176b2af04afc157a83fd7c100e98ee0aad003"
57315764
integrity sha512-JG3eIAj5V9CwcGvuOmoo6LB9kbAYT8HXffUl6memuszlwDC/qvFAJw49XJ5NROSFNPxp3iQg1GqkFhaY/CR0IA==
@@ -6621,6 +6654,15 @@ jsesc@~0.5.0:
66216654
resolved "https://registry.npmjs.org/jsesc/-/jsesc-0.5.0.tgz#e7dee66e35d6fc16f710fe91d5cf69f70f08911d"
66226655
integrity sha1-597mbjXW/Bb3EP6R1c9p9w8IkR0=
66236656

6657+
json-fixer@^1.5.1:
6658+
version "1.6.13"
6659+
resolved "https://registry.yarnpkg.com/json-fixer/-/json-fixer-1.6.13.tgz#27d2f0e837aec54afbc9ec1cd8c1dd965bf534c9"
6660+
integrity sha512-DKQ71M+0uwAG3QsUkeVgh6XREw/OkpnTfHfM+sdmxRjHvYZ8PlcMVF4ibsHQ1ckR63NROs68qUr1I0u6yPVePQ==
6661+
dependencies:
6662+
"@babel/runtime" "^7.14.6"
6663+
chalk "^4.1.2"
6664+
pegjs "^0.10.0"
6665+
66246666
json-parse-better-errors@^1.0.1:
66256667
version "1.0.2"
66266668
resolved "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz#bb867cfb3450e69107c131d1c514bab3dc8bcaa9"
@@ -6931,7 +6973,7 @@ lodash.truncate@^4.4.2:
69316973
resolved "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz#5a350da0b1113b837ecfffd5812cbe58d6eae193"
69326974
integrity sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM=
69336975

6934-
lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.21, lodash@^4.7.0:
6976+
lodash@^4.11.2, lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.21, lodash@^4.7.0:
69356977
version "4.17.21"
69366978
resolved "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c"
69376979
integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==
@@ -7414,7 +7456,7 @@ neo-async@^2.6.0:
74147456
resolved "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz#b4aafb93e3aeb2d8174ca53cf163ab7d7308305f"
74157457
integrity sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==
74167458

7417-
node-fetch@^2.6.1:
7459+
node-fetch@^2.6.0, node-fetch@^2.6.1:
74187460
version "2.6.6"
74197461
resolved "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.6.tgz#1751a7c01834e8e1697758732e9efb6eeadfaf89"
74207462
integrity sha512-Z8/6vRlTUChSdIgMa51jxQ4lrw/Jy5SOW10ObaA47/RElsAN2c5Pn8bTgFGWn/ibwzXTE8qwr1Yzx28vsecXEA==
@@ -8032,6 +8074,11 @@ path-type@^4.0.0:
80328074
resolved "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b"
80338075
integrity sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==
80348076

8077+
pegjs@^0.10.0:
8078+
version "0.10.0"
8079+
resolved "https://registry.yarnpkg.com/pegjs/-/pegjs-0.10.0.tgz#cf8bafae6eddff4b5a7efb185269eaaf4610ddbd"
8080+
integrity sha1-z4uvrm7d/0tafvsYUmnqr0YQ3b0=
8081+
80358082
performance-now@^2.1.0:
80368083
version "2.1.0"
80378084
resolved "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz#6309f4e0e5fa913ec1c69307ae364b4b377c9e7b"
@@ -10499,7 +10546,7 @@ yargs-parser@^20.2.2, yargs-parser@^20.2.3:
1049910546
resolved "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz#2eb7dc3b0289718fc295f362753845c41a0c94ee"
1050010547
integrity sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==
1050110548

10502-
yargs@^15.1.0:
10549+
yargs@^15.0.1, yargs@^15.1.0:
1050310550
version "15.4.1"
1050410551
resolved "https://registry.npmjs.org/yargs/-/yargs-15.4.1.tgz#0d87a16de01aee9d8bec2bfbf74f67851730f4f8"
1050510552
integrity sha512-aePbxDmcYW++PaqBsJ+HYUFwCdv4LVvdnhBy78E57PIor8/OVvhMrADFFEDh8DHDFRv/O9i3lPhsENjO7QX0+A==

0 commit comments

Comments
 (0)