contributors-table

   

GitHub contributors table generator

> Powers the contributors-table.vercel.app 😎

✨ Features

- ⚙️ Flexible settings
- 🔗 Hyperlinks to contributors profiles
- 💡 Hints when hovering over an avatar
- 🎨 Customizable
- 🤝 Images supported by Markdown on GitHub and anywhere!

📦 Installation

``bash
npm install contributors-table


If you are using Bun


bun install contributors-table
`

🚀 Usage

$3

`ts
import { generateContributorsTable } from 'contributors-table'
import { Octokit } from '@octokit/core'

const octokit = new Octokit()
const contributorsList = await octokit.request(
'GET /repos/{owner}/{repo}/contributors',
{
owner: 'octocat',
repo: 'Hello-World'
}
)

const image = generateContributorsTable(contributorsList.data)
//
`

$3

!Contributor Table Example

$3

#### Use another image format

`ts
// Generate a PNG image
generateContributorsTable(..., { format: 'png' })
`

$3

`ts
generateContributorsTable(..., {
// The width of the avatars
width: 60,
// Gap between avatars
gap: 10,
// The number of avatars per row
columns: 10,
// Number of rows
rows: 7,
// The roundness of the avatars
roundness: 50,
// Stroke around avatars
strokeWith: 0.8,
// Whether to render avatars on the server side.
// If false - then the browser itself downloads images from GitHub
// If true - then the script takes care of downloading avatars and embedding them
// Always true if format != 'svg'
ssr: true
})
``

🤝 Contributing

Thank you for considering contributing to contributors-table 😀!
Please read the CONTRIBUTING.md file for more information about how to contribute to this project.

❤️ Support

If you like this project, consider supporting it by starring ⭐ it on GitHub, sharing it with your friends, or buying me a coffee ☕

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.