Guide · Open source
How to use markdown-badges: copy tech badges into your README
Updated · written with AI from the project's own documentation and checked against our catalogue data
Markdown Badges is a curated catalog of small icon labels that you can copy into a GitHub profile or project README to show the tools and technologies you use. This guide shows you how to find a badge by name, copy its markdown line, paste it into your file, and switch to a different badge style. It also covers what the project is not for, such as status badges for builds or versions.
Markdown BadgesIleriayo/markdown-badges · ★ 17.2k · MIT Install options & downloads Quick start
- 1Open the badge list. Go to ileriayo.github.io/markdown-badges or the Badges section of the README on GitHub.
- 2Search by name. Press Ctrl + f (CMD + F on Mac) and type the name of the tool you want.
- 3Copy the markdown. Copy the  element for that badge.
- 4Paste into your README. Paste the element into README.md or your GitHub profile README where you want it to appear.
- 5Optional: change style. Replace for-the-badge in the link with plastic, flat, flat-square or social.
- 6Check the rendered page. Preview or commit the file and confirm each badge displays.
What markdown-badges is and what it is not
Each entry in the repository is a ready-made markdown line for one badge. The repo is organized into categories such as Artificial Intelligence and Bots, Databases, CI, and Version Control. It is used mainly for personal branding and quick visual summaries on a profile page.
It is a list of markdown snippets, not installable software. The README says badges without icons are not added here, and points to shields.io for those. The collection is for static branding badges, so it does not provide live build or version status.
- Good fit: a visual tech-stack section on your GitHub profile README.
- Good fit: showing the main tools a project uses near the top of its README.
- Not a fit: badges without a logo icon (use shields.io instead).
- Not a fit: live build or version status badges.
Find a badge by name on the site or in the repo
The project's live site is at ileriayo.github.io/markdown-badges. You can also browse the Badges section of the README on GitHub. Both let you look up a tool by its name.
On GitHub, press Ctrl + f to bring out the search box, then type the name of the badge you need. The README suggests this same approach for finding a specific badge in the list.
- Open the live site or the repository README.
- Press Ctrl + f (or CMD + F on Mac) and type the tool name.
- Check the category if the name is ambiguous.
Copy the markdown line into your README
Each badge has a markdown element in the form . Copy that element exactly and paste it into your Markdown file, such as README.md. The README uses GitHub profile and project READMEs as the main targets.
Badges are placed as ordinary image links, so you can put several on the same line or in a table. Keep the Name part readable, because it becomes the alt text.
- Copy the full  element, including the brackets and parentheses.
- Paste it into README.md (or your profile README).
- Commit the change and view the rendered page to confirm the badge appears.
Change the badge style
The repo uses for-the-badge as its style for appearance. Shields.io offers 5 styles that can be used with these badges: Plastic, Flat-square, Flat, Social, and For-the-badge. To change style, replace for-the-badge in the markdown link with another style name.
The README gives examples using the flat and plastic styles. Keep the same style across all badges in a section if you want a consistent look.
- Plastic: style=plastic
- Flat-square: style=flat-square
- Flat: style=flat
- Social: style=social
- For-the-badge: style=for-the-badge (the repo default)
https://shields.io/badge/style-flat-green?logo=appveyor&style=flatSearch for a badge that is not listed
The repo focuses on badges that use icons from the simple-icons project, so it does not add badges without icons. If the tool you need has no logo in that set, the README points you to shields.io to make a custom badge.
Shields.io is also the source of the style options listed above, so the two projects work together.
- Check the category list and search by name first.
- If there is no icon, build the badge with shields.io.
- Shields.io styles can be applied to badges from this list.
What people use it for
- A GitHub profile README with a visual tech-stack row of languages, databases and tools.
- A project README that shows the main tools or CI systems the project uses near the top.
- A consistent badge style across many badges, using the same style parameter throughout.
Frequently asked questions
Is markdown-badges free to use?
The repository is licensed under MIT, as listed on its GitHub page. You copy the markdown lines into your own README files, and the source describes the project as an open-source collection.
Do I need to install anything to use markdown-badges?
No. The project is a web-based list of markdown snippets, and the README lists no install commands or prerequisites. You search the site or repo and paste the markdown into your file.
Why is my badge not showing on GitHub?
The source does not cover troubleshooting for rendering problems. Check that you copied the full  element with its brackets and parentheses, and that the link is intact. Preview the file on GitHub to confirm.
How do I change the badge style?
Replace for-the-badge in the markdown link with plastic, flat, flat-square or social. The README shows examples of these shields.io styles.
Can I make a badge without an icon?
The repo does not add badges without icons. The README recommends shields.io for making badges without icons.
What are the alternatives to markdown-badges?
The README and our analysis name shields.io and simple-icons as comparable projects. Shields.io is the one the README points to for badges without icons and for style options.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Markdown Badges suits developers who want a consistent, logo-based tech-stack section on a GitHub profile or project README. Pick shields.io instead if you need badges without icons or live build and version status, and do not expect an installable tool.
Install options & downloads