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

Search documentation

Search all badge providers, guides, and reference docs.

Getting Started

IntroductionREADME StudioCLIAgent SkillNewSelf-HostingAPI ReferenceToken PoolSponsor
ThemesStylesLogos & IconsFontsLight & Dark ModeBrands

Badges

Badge GroupStatic BadgeDynamic JSONHTTPS Endpoint

Charts

Overview

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

Brands

Reference a curated brand — colors, theme, font, and logo — from any badge or README header by URL. Edit once, update everywhere.

A brand is a named, reusable set of style tokens. Reference it from any badge or header URL and it applies the brand's colors, theme, font, and logo. Brands are curated by the shieldcn maintainers; anyone can reference an existing brand by its slug.

Referencing a brand

Two equivalent forms:

<!-- Query param -->
![build](https://shieldcn.dev/github/acme/app/ci.svg?brand=acme)

<!-- Pretty path -->
![build](https://shieldcn.dev/b/acme/github/acme/app/ci.svg)

The brand supplies theme, color, labelColor, valueColor, font, variant, radius, logo, logoColor, gradient, and mode when you don't set them explicitly.

Precedence

Explicit query params always win, so you can reference a brand and still override one value per badge:

![v](https://shieldcn.dev/npm/acme-ui.svg?brand=acme&variant=outline)

Precedence is explicit query param > brand value > default.

Branded badges use a matching brand automatically

Any badge rendered with variant=branded looks for a managed brand whose slug matches the provider and applies it automatically — no ?brand= needed. So if you create a brand named github, every variant=branded GitHub badge on your site (and in anyone's README) adopts that brand's color, logo, font, radius, and gradient:

<!-- Uses the "github" brand if one exists, else the built-in GitHub color -->
![stars](https://shieldcn.dev/github/stars/vercel/next.js.svg?variant=branded)

Edit the github brand once and every branded GitHub badge restyles on the next fetch. This only applies to variant=branded; other variants are unaffected. An explicit ?brand= or ?color= still wins, and a provider with no matching brand falls back to its built-in brand color.

Brand logos and fonts

When a brand has hosted assets, opt into them per badge:

<!-- Use the brand's hosted logo (mode-aware light/dark) -->
![build](https://shieldcn.dev/github/acme/app/ci.svg?brand=acme&logo=brand)

<!-- Render in the brand's uploaded font -->
![v](https://shieldcn.dev/npm/acme-ui.svg?brand=acme&font=brand)

font=brand-mono and font=brand-heading select the brand's other uploaded typefaces.

README headers

README header banners accept ?brand= too, so your header logo, colors, and font all follow the brand:

![header](https://shieldcn.dev/header/banner/Acme.svg?brand=acme&logo=brand)

Editing propagates everywhere

Because every embed references the brand by URL, editing the brand updates all of them. Propagation is bounded by a short cache TTL, so a rebrand shows up across GitHub's Camo proxy within minutes.

Unknown or deleted brands fail open: the badge renders with defaults instead of breaking. A shipped README badge is never a broken image.

On This Page

Referencing a brandPrecedenceBranded badges use a matching brand automaticallyBrand logos and fontsREADME headersEditing propagates everywhere