8-bit style badges for your GitHub profile and projects
Retro pixel-art badges inspired by classic video games. Perfect for adding personality to your README files.
Badges โข Usage โข Contributing
Click to expand
| Name | Badge | Markdown |
|---|---|---|
| Redis |  |
|
| Supabase |  |
Click to expand usage guide
https://bitbadges.vercel.app/badge/:text/:color
| Parameter | Type | Description | Example |
|---|---|---|---|
text |
path | Badge text | TypeScript |
color |
path | Hex color (no #) | 3178C6 |
logo |
query | Logo name | ?logo=typescript |
logoColor |
query | Logo variant | ?logoColor=black |
textColor |
query | Text color | ?textColor=white |
scale |
query | Size preset or number | ?scale=md |
| Preset | Scale | Example |
|---|---|---|
xs |
1x | |
sm |
2x | |
md |
3x | |
lg |
4x | |
xl |
5x |
Click to expand contributing guide
- Create a folder in
assets/logos/with the logo name - Add 16x16 PNG files:
assets/logos/
โโโ mylogo/
โโโ mylogo.png # default
โโโ mylogo-white.png # white variant (optional)
โโโ mylogo-black.png # black variant (optional)
- Open a PR!
# Clone the repo
git clone https://github.com/yourusername/pixel-badges.git
# Install dependencies
pnpm install
# Start dev server
pnpm dev
# Open http://localhost:3000| Endpoint | Description |
|---|---|
GET /badge/:text/:color |
Generate a badge |
GET /logos |
List available logos (JSON) |
GET / |
API info |
MIT
Made with ๐ฎ by oshanKHZ
Inspired by shields.io and retro gaming