A Python utility for generating customized Shields.io badges as well as a static API for additional icons not included in Simple Icons.
This utility simplifies the creation and customization of badges in the style of Shields.io that can be used in your README files, documentation, websites, and wherever else you'd like. It:
- Converts SVG icons to base64 for use in Shields.io badges
- Supports both named colors and hex color codes
- Downloads generated badges for local use
- Supports concurrent downloads for efficiency
To use this repository as a static API, all you need to do is pass the slug
you want to the URL: https://raw.githubusercontent.com/gtkacz/shieldsio-plus/refs/heads/main/assets/shields/{style}/{slug}.svg
. To add more icons to the static API, see below.
Style | Sample |
---|---|
flat | |
true_flat* | |
flat_square | |
plastic | |
for_the_badge | |
social |
Family Name | Type | Sample |
---|---|---|
Tektur | Sans-Serif |
To create a new badge in the static API, simply create a pull request to add your desired icon as an svg to the icons folder. And we'll do the rest for you!
SVG files should follow the naming convention: slug_DisplayText_HexColor.svg
Examples:
linkedin_LinkedIn_007EBB.svg
- Creates a LinkedIn badge with background color #007EBB and save it under thelinkedin
slug.orcid-white_ORCID_FFF.svg
- Creates an ORCID badge with white background (#FFF) and save it under theorcid-white
slug.