Generators

contributors


The contributors generator generates an image of contributors using contrib.rocks service plus additional data about authors and license.

Example

Input

<!-- automd:contributors author="pi0" license="MIT" -->
<!-- /automd -->

Output

<!-- automd:contributors author="pi0" license="MIT" -->

Published under the [MIT](https://github.com/unjs/automd/blob/main/LICENSE) license.
Made by [@pi0](https://github.com/pi0) and [community](https://github.com/unjs/automd/graphs/contributors) ๐Ÿ’›
<br><br>
<a href="https://github.com/unjs/automd/graphs/contributors">
<img src="https://contrib.rocks/image?repo=unjs/automd" />
</a>

<!-- /automd -->

Arguments

provider
string

Available providers are markupgo and contrib.rocks (default is contrib.rocks)

github
string

Github repository name (by default tries to read from package.json) e.g. unjs/automd

max
number

Max contributor count (100 by default).

Set to 0 for all contributors. Max avatar count is 500. (Only available for markupgo)

circleSize
number

Size of contributor circle (40 by default) (Only available for markupgo)

circleSpacing
number

Spacing between contributor circles (6 by default) (Only available for markupgo)

circleRadius
number

Radius of contributor circle (40 by default) (Only available for markupgo)

center
boolean

Center the contributor circles (false by default) (Only available for markupgo)

markupGoLogo
boolean

Show markupGo logo for credits.

width
number

Width of the image (890 by default) (Only available for markupgo)

anon
boolean

Include anonymous users (false by default)

author
string

Comma separated list of github usersnames.

license
string

Name of license.