Boneyard Tools

Markdown Badge Generator

Make custom shields.io badges for your README or docs. Choose the label, message and color, add a style or logo, and copy ready-to-paste Markdown or HTML. Spaces, dashes and underscores are escaped for you so the badge URL is always valid.

How to make a Markdown badge

  1. Type the label and message, then pick a color, style and optional logo.
  2. Check the live badge preview to confirm it looks right.
  3. Copy the Markdown or HTML and paste it into your README or page.

Examples

Build passing badge

{ "label": "build", "message": "passing", "color": "brightgreen" }
![build](https://img.shields.io/badge/build-passing-brightgreen)

Linked license badge

{ "label": "license", "message": "MIT", "color": "blue", "link": "https://opensource.org/licenses/MIT" }
[![license](https://img.shields.io/badge/license-MIT-blue)](https://opensource.org/licenses/MIT)

Frequently asked questions

What is a shields.io badge?

shields.io is a free service that renders small status badges as images, like the build, version and license badges you see at the top of many READMEs. This tool builds the static badge URL for you and wraps it in Markdown or HTML.

How are spaces and dashes handled in the badge text?

shields.io uses dashes to separate the label, message and color, so the text has to be escaped. A literal dash becomes --, a literal underscore becomes __, and a space becomes _. This tool applies those rules and URL-encodes the rest, so characters like % or / still work.

Can I add a logo or change the style?

Yes. Pick a style such as flat, flat-square or for-the-badge, and add a logo by its simpleicons.org slug (for example github or typescript). They are added to the badge URL as style and logo query parameters.

How do I make the badge clickable?

Add a link and the Markdown output becomes [![label](badge-url)](your-link), and the HTML wraps the image in an anchor. This is how badges link to your CI dashboard, releases page or license.

What colors can I use?

Use a named shields.io color like brightgreen, blue, orange or red, a semantic name like success or critical, or any hex code such as ff69b4. Hex codes do not need a leading hash.

Is anything sent to a server?

No. The badge URL and snippets are built entirely in your browser. Your browser only contacts shields.io when it loads the badge image itself, exactly as it would when the README is viewed.

Related tools