https://github.com/veaba/contributors
【WIP】Generate a contributors community SVG for your Repository.（贡献者，来个大合照！one~ two ~ three~，茄子，咔嚓！）
https://github.com/veaba/contributors
Last synced: about 1 year ago
JSON representation
【WIP】Generate a contributors community SVG for your Repository.（贡献者，来个大合照！one~ two ~ three~，茄子，咔嚓！）
- Host: GitHub
- URL: https://github.com/veaba/contributors
- Owner: veaba
- Created: 2022-07-12T14:41:52.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-28T15:46:24.000Z (almost 4 years ago)
- Last Synced: 2025-01-30T17:39:45.758Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 11 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
【WIP】：Website not yet ready
You can generate as many repository contributor avatar group photos as you want.
## TODO How use
### Github Actions
### Website
## Design
- [x] Automatic clipping and rounding of Avatar
- [x] Horizontal Auto Center
### size
### category(TODO)
```diff
export default {
+ 'veaba/veaba': {
+ category: [
+ {
+ label: 'Platinum Sponsors',
+ users: ['veaba']
+ },
+ {
+ label: 'Gold Sponsors',
+ users: ['veaba2']
+ },
+ {
+ label: 'Silver Sponsors',
+ users: ['veaba3']
+ },
+ {
+ label: 'Sponsors',
+ users: ['veaba4']
+ }
+ ]
}
}
```
### circle
- `circle`: default: circle
- `isRadius:false`: you can disabled the feature
```diff
export default {
+ 'vuejs-translations/docs-zh-cn': {
+ isRadius: false,
+ }
}
```
### margin
### text display
- [] configure text color? （It't necessary?）
### config
maybe you need filter some users.
emm, just like as `vuejs-translations/docs-zh-cn`, it's a Chinese translation for Vue docs community, we does't need show non Chinese contributors in our repo, actually, `vuejs-translations/docs-zh-cn` upstream repo is `vuejs/docs`.
in `config.ts` add your repo configure.
```diff
export default {
+ 'veaba/veaba': {
+ ignore: [] // if you need ignore some users
+ }
}
```
## Examples
### demo：vuejs-translations/docs-zh-cn contributors
:point_down: :point_down: :point_down: ↓↓↓↓↓↓ :point_down: :point_down: :point_down:
:point_up: :point_up: :point_up: ↑↑↑↑↑↑ :point_up: :point_up: :point_up:
in `config.js`:
```diff
+ const config: ConfigItem =
+ {
+ // https://github.com/vuejs-translations/docs-zh-cn
+ 'vuejs-translations/docs-zh-cn': {
+ ignore: [
+ 'yyx990803', 'NataliaTepluhina', 'skirtles-code', 'bencodezen', 'dependabot[bot]',
+ 'LinusBorg', 'KiritaniAyaka', 'Alex-Sokolov', 'sdras', 'marina-mosti', 'CyberAP',
+ 'danielkellyio', 'tylermercer',
+ ], // if you need ignore some users
+ // users: [],?? maybe we need this field.
+ ignoreTotal: 1, // filter some users whose total is too low
+ size: 100,
+ height: 2500, // TODO: maybe automatic
+ width: 800,
+ fontSize: 30,
+ }
+ }
```