veaba / contributors

【WIP】Generate a contributors community SVG for your Repository.（贡献者，来个大合照！one~ two ~ three~，茄子，咔嚓！）

【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

• Automatic clipping and rounding of Avatar
• Horizontal Auto Center

size

category(TODO)

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

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.

export default {
+  'veaba/veaba': {
+    ignore: [] // if you need ignore some users
+  }
}

Examples

demo：vuejs-translations/docs-zh-cn contributors

👇 👇 👇 ↓↓↓↓↓↓ 👇 👇 👇

☝️ ☝️ ☝️ ↑↑↑↑↑↑ ☝️ ☝️ ☝️

in config.js:

+ 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,
+   }
+ }