Markdown Badge Generator
Create shields.io badges for your README and documentation.
About Markdown Badges
Badges are small status images commonly used in README files to display project information at a glance. They typically show version numbers, build status, license info, download counts, and more.
What is Shields.io?
Shields.io is a service that generates SVG badges for use in documentation. It supports both static badges (with custom text) and dynamic badges that pull data from various services.
Badge Anatomy
LABEL (left, gray background) | MESSAGE (right, colored background)
Common Badge Types
Version Badges
Show your project version:
License Badges
Display your project license:
Build Status
Show CI/CD build status:
Downloads
Display download counts:
Badge Styles
| Style | Description | Best For |
|---|---|---|
| flat | Clean, modern look | Most projects (default) |
| flat-square | Square corners | Minimalist designs |
| plastic | Glossy, 3D effect | Classic GitHub style |
| for-the-badge | Large, bold text | Headers, prominent display |
| social | Rounded, social style | Social links, followers |
Color Options
Named Colors:
- brightgreen
- green
- yellowgreen
- yellow
- orange
- red
- blue
- lightgrey
Semantic Colors:
- success (green)
- important (orange)
- critical (red)
- informational (blue)
- inactive (grey)
Custom: Use hex codes like ff69b4
Adding Logos
Add brand logos using Simple Icons names:
  
Find logo names at simpleicons.org
Dynamic Badges
Shields.io can pull live data from services:
- npm: Package version, downloads
- GitHub: Stars, forks, issues, license
- PyPI: Python package info
- Docker Hub: Image pulls, size
- CI Services: Build status (Travis, GitHub Actions)
Best Practices
- Group badges: Organize by category (build, quality, info)
- Use consistent styles: Pick one style for all badges
- Keep it minimal: 3-6 badges is usually enough
- Put important first: Build status, version, license
- Link to relevant pages: Badge clicking should go somewhere useful
Example README Badge Section
## Status    
Popular Badges
Version:
License:
Build:
Coverage:
