shieldcn
Docs
Studio
Showcase
Sponsor
jal-co/shieldcn597
shieldcn

Member of the Vercel OSS Program

Analytics provided by OpenPanel

Monitored by Sentry

Powered by Neon.

Community

GitHubjal-co/uiStatsllms.txtPrivacyContact

Product

DocumentationAPI ReferenceToken PoolGeneratorAgent Skill

inspired by shields.io and badgen.net

Made with in by Justin Levine

shieldcn
Docs
Studio
Showcase
Sponsor
jal-co/shieldcn597

Search documentation

Search all badge providers, guides, and reference docs.

Getting Started

IntroductionREADME StudioCLIAgent SkillNewSelf-HostingAPI ReferenceToken PoolSponsor

Badges

Badge GroupStatic BadgeDynamic JSONHTTPS Endpoint

Charts

OverviewStar history

Headers

OverviewGenerator

Sponsors

OverviewGenerator

Contributors

OverviewGenerator
shieldcn

Member of the Vercel OSS Program

Analytics provided by OpenPanel

Monitored by Sentry

Powered by Neon.

Community

GitHubjal-co/uiStatsllms.txtPrivacyContact

Product

DocumentationAPI ReferenceToken PoolGeneratorAgent Skill

inspired by shields.io and badgen.net

Made with in by Justin Levine

Contributors

A grid of your repository's contributors — every contributor's avatar, rendered as one portable image for your README. Like contrib.rocks, but shadcn-styled.

The contributors image renders a grid of a repository's top contributors — their avatars, linked to their GitHub profiles — as a single portable SVG (or PNG) served from shieldcn. It's a contrib.rocks-style image, but built from shadcn-styled chrome and the same background system as headers and sponsors. Everything is encoded in the image URL, so it works anywhere a Markdown image does and never needs a build step or a CI job.

![next.js contributors](https://shieldcn.dev/contributors/vercel/next.js.svg)

Builder

The fastest way to make a contributors image is the interactive generator. Enter an owner and repo, pick a background, theme, and size, then copy the Markdown.

Open the contributors generator

URL format

/contributors/{owner}/{repo}.svg     SVG grid
/contributors/{owner}/{repo}.png     PNG grid
/contributors/{owner}/{repo}.json    resolved contributor list (JSON)

{owner}/{repo} is any public GitHub repository. Drop it into your README with a linked Markdown image:

[![Contributors](https://shieldcn.dev/contributors/vercel/next.js.svg)](https://github.com/vercel/next.js/graphs/contributors)

Or center it with an HTML block:

<p align="center">
  <a href="https://github.com/vercel/next.js/graphs/contributors">
    <img src="https://shieldcn.dev/contributors/vercel/next.js.svg" alt="Contributors" />
  </a>
</p>

Ordering and filtering

Contributors are ordered by number of contributions (commits), descending — the same order as GitHub's contributors graph. Bots (accounts ending in [bot], or of GitHub type Bot) are excluded by default; include them with ?bots=true.

  • limit — cap how many avatars are shown (1–100, default 60).
  • min — only include contributors with at least this many contributions.
  • bots — set true to include bot accounts.
[![Contributors](https://shieldcn.dev/contributors/vercel/next.js.svg?limit=30&min=5)](https://github.com/vercel/next.js/graphs/contributors)

limit=24, names=true

![next.js contributors with names](https://shieldcn.dev/contributors/vercel/next.js.svg?limit=24&names=true)

Sizing and layout

The size parameter sets the avatar diameter; use width to set the canvas width — avatars wrap into as many rows as needed. Names are off by default for a dense avatar grid; turn them on with names=true.

ParameterValuesDefault
size24–140 (px)64
width320–2000 (px)800
limit1–10060
min≥ 00
namestrue, falsefalse
botstrue, falsefalse
titleAlignleft, center, rightleft
alignleft, center, right (avatars)center
radius0–80 (px)12
bordertrue, falsetrue
watermarktrue, falsefalse
![Contributors](https://shieldcn.dev/contributors/vercel/next.js.svg?size=48&limit=40)

Title and colors

The grid has a "Contributors" heading by default. Override it with title=..., or hide it with title=false. Color controls:

  • bg — a solid background color (hex without #), or transparent to blend into the page.
  • accent — the color of the hairline rule under the title (hex without #).
![Contributors](https://shieldcn.dev/contributors/vercel/next.js.svg?title=Built+by&bg=transparent)

Backgrounds

The card uses the same premade background system as headers — so it's just as customizable. Set a preset with ?preset=:

PresetDescription
surfaceClean flat zinc surface. The default.
gradientSubtle neutral vertical gradient.
dotsDot grid over the surface.
gridLine grid over the surface.
graphFine and coarse graph paper.
glowSoft themed spotlight from the top.
transparentNo surface fill — blends into the page.

glow preset, blue theme

![contributors with the glow preset and blue theme](https://shieldcn.dev/contributors/vercel/next.js.svg?preset=glow&theme=blue)

For full control, override the background directly:

  • theme — tints the glow/accent: zinc, slate, blue, green, rose, orange, violet, purple, cyan, emerald.
  • gradient — comma-separated hex stops with an optional trailing angle, e.g. gradient=7c2d12,9f1239,86198f,135.
  • pattern — dots, grid, graph, or none.
  • glow — the spotlight color (hex without #).
  • bg — a solid color (hex without #), or transparent.
  • image — a background photo (Unsplash or any image URL), inlined behind an auto scrim; tune it with overlay (0–1) and tint.
![Contributors](https://shieldcn.dev/contributors/vercel/next.js.svg?gradient=7c2d12,9f1239,86198f,135)

Light and dark mode

The grid reads correctly in both modes. Pass mode=light or mode=dark, or pair two images in a <picture> element so it follows the reader's GitHub theme. See Light & Dark Mode.

Parameters

In addition to the shared mode and font parameters from the API reference:

ParameterValuesDefault
titlestring, or falseContributors
limit1–10060
min≥ 00
namestrue, falsefalse
botstrue, falsefalse
titleAlignleft, center, rightleft
alignleft, center, right (avatars)center
size24–140 (px)64
width320–2000 (px)800
presetsurface, gradient, dots, grid, graph, glow, transparentsurface
themezinc, slate, blue, green, rose, orange, violet, purple, cyan, emerald—
bghex without #, or transparentcard surface
gradientcomma-separated hex stops, optional trailing angle—
patterndots, grid, graph, nonepreset
glowhex without #per preset
imageUnsplash / image URL, or data: URI—
overlay0–10.45
tinthex without #000000
accenthex without #—
radius0–80 (px)12
bordertrue, falsetrue
watermarktrue, falsefalse
modedark, lightdark

Data source

Contributor data comes from the GitHub REST contributors API (/repos/{owner}/{repo}/contributors), ordered by contributions descending. Avatars are fetched once and inlined into the image, and the list is cached for an hour (serving the last-known-good list during any GitHub outage). The image renders the top contributors up to limit; very large repositories are capped at 100. A repository that doesn't exist or has no contributors renders an empty-state message.

On This Page

BuilderURL formatOrdering and filteringSizing and layoutTitle and colorsBackgroundsLight and dark modeParametersData source