Experiment with different parameters and see your badge in real-time:
| Parameter | Description | Default | Examples |
|---|---|---|---|
text |
Badge text content | "Badge" |
text=Hello%20World |
bgColor |
Background color | "white" |
bgColor=blue, bgColor=#ff6b6b |
icon |
Icon from library or URL | null |
icon=fontawesome-solid:star, icon=bootstrap:heart, icon=https://example.com/logo.svg |
iconColor |
Icon color tint (works best with library icons) | null |
iconColor=red |
textColor |
Text color | "auto" |
textColor=white, textColor=#333 |
edges |
Edge style | "rounded" |
edges=rounded, edges=square, edges=pill |
You can use icons from popular libraries by specifying provider:icon-name format:
| Provider | Format | Examples |
|---|---|---|
| FontAwesome Solid | fontawesome-solid:icon |
fontawesome-solid:star, fontawesome-solid:heart |
| FontAwesome Regular | fontawesome-regular:icon |
fontawesome-regular:star, fontawesome-regular:heart |
| FontAwesome Brands | fontawesome-brands:icon |
fontawesome-brands:github, fontawesome-brands:twitter |
| Bootstrap Icons | bootstrap:icon |
bootstrap:star, bootstrap:heart |
| Heroicons Outline | heroicons-outline:icon |
heroicons-outline:star, heroicons-outline:heart |
| Heroicons Solid | heroicons-solid:icon |
heroicons-solid:star, heroicons-solid:heart |
| Lucide | lucide:icon |
lucide:star, lucide:heart |
| Tabler | tabler:icon |
tabler:star, tabler:heart |
| Simple Icons | simple-icons:icon |
simple-icons:github, simple-icons:nodejs |
The server automatically fetches icons from their respective CDNs, processes them for optimal quality, and embeds them directly into your badges:
fontawesome-solid:star or bootstrap:heart - full color customization supporthttps://example.com/icon.svg - iconColor may not work for all images&iconColor=red to tint library icons (may not work with custom images)You can use any of these color names or hex codes for background and text colors:
black
white
grayLight
gray
grayDark
slate
charcoal
blue
lightBlue
skyBlue
teal
cyan
green
mint
seafoam
olive
emerald
yellow
amber
orange
peach
gold
red
coral
salmon
pink
rose
purple
lavender
lilac
violet
indigo
sand
beige
ivory
blush
sage
dustyBlue
terracotta
https://badges.0xleo.dev/badge?text=Rounded&bgColor=blue&edges=rounded
https://badges.0xleo.dev/badge?text=Square&bgColor=green&edges=square
https://badges.0xleo.dev/badge?text=Pill&bgColor=red&edges=pill
Add badges to your README.md file. Toggle between code and preview:
Show your project's technology stack with icons from popular libraries.
Display build status, version numbers, and licensing information with relevant icons.
Link to your social media profiles and community platforms with brand icons.
We welcome contributions! Please see our GitHub repository for contribution guidelines.