shieldcn
Docs
Studio
Showcase
Sponsor
jal-co/shieldcn588
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/shieldcn588

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

Getting Started

Beautiful README badges. Drop-in shields.io replacement styled as shadcn/ui buttons.

What is shieldcn?

shieldcn serves SVG badge images that look like shadcn/ui Button components — same font, border-radius, padding, and color tokens. Use them in GitHub READMEs, npm pages, docs sites, and anywhere that accepts <img> tags.

Quick start

Add a badge to your README:

![npm version](https://shieldcn.dev/npm/react.svg)

That's it. No configuration, no API keys, no build step. Both .svg and .png extensions are supported — just swap the extension.

Use .svg by default for the crispest badge rendering. Use .png only where SVG images are not accepted.

Badge types

BadgeURL pattern
npm version/npm/{package}
npm downloads/npm/dw/{package}
npm license/npm/license/{package}
npm types/npm/types/{package}
GitHub stars/github/stars/{owner}/{repo}
GitHub forks/github/forks/{owner}/{repo}
GitHub release/github/release/{owner}/{repo}
GitHub CI/github/ci/{owner}/{repo}
GitHub license/github/license/{owner}/{repo}
GitHub issues/github/issues/{owner}/{repo}
GitHub PRs/github/prs/{owner}/{repo}
GitHub commits/github/commits/{owner}/{repo}
Discord online/discord/{serverId}
Discord members/discord/members/{inviteCode}
NBA team fan/nba or /nba/{team}
Reddit karma/reddit/{type}/u/{user}
Static/badge/{label}-{message}-{color}
Dynamic JSON/badge/dynamic/json?url=...&query=...
HTTPS endpoint/https/{hostname}/{path}
Memo/memo/{key}

Append .svg or .png to any endpoint (e.g. /npm/react.svg or /npm/react.png).

Variants

Every badge supports shadcn Button variants:

![default](https://shieldcn.dev/npm/react.svg)
![secondary](https://shieldcn.dev/npm/react.svg?variant=secondary)
![outline](https://shieldcn.dev/npm/react.svg?variant=outline)
![ghost](https://shieldcn.dev/npm/react.svg?variant=ghost)
![destructive](https://shieldcn.dev/npm/react.svg?variant=destructive)

Sizes

![xs](https://shieldcn.dev/npm/react.svg?size=xs)
![sm](https://shieldcn.dev/npm/react.svg?size=sm)
![default](https://shieldcn.dev/npm/react.svg?size=default)
![lg](https://shieldcn.dev/npm/react.svg?size=lg)

Icons

Badges auto-detect icons per provider. Override with any Simple Icons slug or React Icons component name:

Use logo=false to remove the icon entirely, or pass a data:image/svg+xml;base64,... string for a fully custom icon.
![react](https://shieldcn.dev/npm/react.svg?logo=react)
![star](https://shieldcn.dev/badge/stars-42-blue.svg?logo=ri:GoStarFill)
![no icon](https://shieldcn.dev/npm/react.svg?logo=false)

Response formats

  • .svg — SVG image (crisp, scalable, recommended default)
  • .png — PNG image (raster fallback for clients that reject SVG)
  • .json — raw badge data
  • /shields.json — shields.io-compatible endpoint

Use .svg for the sharpest result. Use .png only for platforms that reject SVG images.

Built with

Badge components for React → jal-co/ui

On This Page

What is shieldcn?Quick startBadge typesVariantsSizesIconsResponse formatsBuilt with
Advertisement
Advertisement