https://github.com/hunghg255/contributorkit

Toolkit for generating contributors images
https://github.com/hunghg255/contributorkit

contributors generator npm package

Last synced: about 2 months ago
JSON representation

Toolkit for generating contributors images

• Host: GitHub
• URL: https://github.com/hunghg255/contributorkit
• Owner: hunghg255
• License: mit
• Created: 2024-05-03T12:04:49.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-04T02:20:35.000Z (8 months ago)
• Last Synced: 2024-11-01T09:45:59.437Z (2 months ago)
• Topics: contributors, generator, npm, package
• Language: TypeScript
• Homepage:
• Size: 12.6 MB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# contributorkit

[![NPM version](https://img.shields.io/npm/v/contributorkit?color=a1b858&label=)](https://www.npmjs.com/package/contributorkit)

Toolkit for generating contributors images.

## Usage

Run:

```base

npx contributorkit

```

[Example Setup](./example/) | [GitHub Actions Setup](https://github.com/hunghg255/contributorkit/blob/main/.github/workflows/scheduler.yml) | [Generated SVG](https://cdn.jsdelivr.net/gh/hunghg255/contributorkit/example/contributor.svg)

## Configurations

Create `contributorkit.config.js` file with:

```ts

import { defineConfig, tierPresets } from 'contributorkit'

export default defineConfig({

  outputDir: '.',

  owner: 'vercel',

  repo: 'next.js',

  renders: [

    {

      name: 'contributor',

      width: 800,

      formats: ['svg', 'png'],

    },

    {

      name: 'contributor-wide',

      width: 1000,

      formats: ['svg'],

    },

    {

      renderer: 'circles',

      name: 'contributor-circles',

      width: 1000,

    },

  ],

})

```

Also check [the example](./example/).

## Utils

Check the type definition or source code for more utils available.

## Renderers

We provide two renderers built-in:

- `tiers`: Render sponsors in tiers.

- `circles`: Render sponsors in packed circles.

### Tiers Renderer



  

    

  



### Circles Renderer



  

    

  



## License

[MIT](./LICENSE) License © 2024 [Hung](https://github.com/hunghg255)