Skip to content

gtkacz/shieldsio-plus

Repository files navigation

Shields.io+

A Python utility for generating customized Shields.io badges as well as a static API for additional icons not included in Simple Icons.

Overview

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:

  1. Converts SVG icons to base64 for use in Shields.io badges
  2. Supports both named colors and hex color codes
  3. Downloads generated badges for local use
  4. Supports concurrent downloads for efficiency

Usage

Basic Usage

Static API

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.

Available Slugs

Slug Sample
azure azure
azure-white azure-white
confluent confluent
confluent-white confluent-white
dot-net-core dot-net-core
dot-net-core-white dot-net-core-white
gitcode gitcode
gitcode-black gitcode-black
gitcode-white gitcode-white
gogs gogs
gogs-white gogs-white
hacktoberfest hacktoberfest
hacktoberfest-black hacktoberfest-black
hacktoberfest-white hacktoberfest-white
ibm ibm
ibm-cloud ibm-cloud
ibm-cloud-white ibm-cloud-white
ibm-white ibm-white
ieee ieee
ieee-white ieee-white
lattes lattes
lattes-white lattes-white
linkedin linkedin
linkedin-blue linkedin-blue
linkedin-white linkedin-white
linkedin-white-logo linkedin-white-logo
magento magento
magento-grey magento-grey
magento-white magento-white
microsoft microsoft
microsoft-white microsoft-white
oracle oracle
oracle-cloud oracle-cloud
oracle-cloud-white oracle-cloud-white
oracle-white oracle-white
orcid orcid
orcid-grey-logo orcid-grey-logo
orcid-logo orcid-logo
orcid-white orcid-white
orcid-white-logo orcid-white-logo
phacility phacility
play-framework play-framework
plnkr plnkr
plnkr-white plnkr-white
sbc sbc
sbc-blue sbc-blue
sourcegraph sourcegraph
sourcegraph-black sourcegraph-black
sourcegraph-white sourcegraph-white
sql-developer sql-developer
sql-developer-white sql-developer-white
twitter twitter
twitter-white twitter-white
visual-studio visual-studio
visual-studio-white visual-studio-white
vs-code vs-code
vs-code-black vs-code-black
vs-code-dark vs-code-dark
vs-code-white vs-code-white
windows-10 windows-10
windows-10-blue windows-10-blue
windows-7 windows-7
windows-7-white windows-7-white
zeplin zeplin
zeplin-white zeplin-white

Available Styles

Style Sample
flat twitter
true_flat* twitter
flat_square twitter
plastic twitter
for_the_badge twitter
social windows-10

Available Fonts

Family Name Type Sample
Andale Mono Monospace twitter
Arial Sans-Serif twitter
Arial Black Sans-Serif twitter
Arial Narrow Sans-Serif twitter
Arial Rounded Mt Bold Sans-Serif twitter
Avant Garde Sans-Serif twitter
Baskerville Serif twitter
Big Caslon Serif twitter
Bodoni Mt Serif twitter
Book Antiqua Serif twitter
Brush Script Mt Cursive twitter
Calibri Sans-Serif twitter
Calisto Mt Serif twitter
Cambria Serif twitter
Candara Sans-Serif twitter
Century Gothic Sans-Serif twitter
Consolas Monospace twitter
Copperplate Fantasy twitter
Courier New Monospace twitter
Didot Serif twitter
Franklin Gothic Medium Sans-Serif twitter
Futura Sans-Serif twitter
Garamond Serif twitter
Geneva Sans-Serif twitter
Georgia Serif twitter
Gill Sans Sans-Serif twitter
Goudy Old Style Serif twitter
Helvetica Neue Sans-Serif twitter
Hoefler Text Serif twitter
Impact Sans-Serif twitter
Lucida Bright Serif twitter
Lucida Console Monospace twitter
Lucida Grande Sans-Serif twitter
Lucida Sans Typewriter Monospace twitter
Optima Sans-Serif twitter
Palatino Serif twitter
Papyrus Fantasy twitter
Perpetua Serif twitter
Rockwell Serif twitter
Rockwell Extra Bold Monospace twitter
Segoe Ui Sans-Serif twitter
Tahoma Sans-Serif twitter
Timesnewroman Serif twitter
Trebuchet Ms Sans-Serif twitter
Verdana Sans-Serif twitter
Monaco Monospace twitter
Web-safe Fonts
Family Name Type Sample
Andale Mono Monospace twitter
Arial Sans-Serif twitter
Arial Black Sans-Serif twitter
Arial Narrow Sans-Serif twitter
Arial Rounded Mt Bold Sans-Serif twitter
Avant Garde Sans-Serif twitter
Baskerville Serif twitter
Big Caslon Serif twitter
Bodoni Mt Serif twitter
Book Antiqua Serif twitter
Brush Script Mt Cursive twitter
Calibri Sans-Serif twitter
Calisto Mt Serif twitter
Cambria Serif twitter
Candara Sans-Serif twitter
Century Gothic Sans-Serif twitter
Consolas Monospace twitter
Copperplate Fantasy twitter
Courier New Monospace twitter
Didot Serif twitter
Franklin Gothic Medium Sans-Serif twitter
Futura Sans-Serif twitter
Garamond Serif twitter
Geneva Sans-Serif twitter
Georgia Serif twitter
Gill Sans Sans-Serif twitter
Goudy Old Style Serif twitter
Helvetica Neue Sans-Serif twitter
Hoefler Text Serif twitter
Impact Sans-Serif twitter
Lucida Bright Serif twitter
Lucida Console Monospace twitter
Lucida Grande Sans-Serif twitter
Lucida Sans Typewriter Monospace twitter
Optima Sans-Serif twitter
Palatino Serif twitter
Papyrus Fantasy twitter
Perpetua Serif twitter
Rockwell Serif twitter
Rockwell Extra Bold Monospace twitter
Segoe Ui Sans-Serif twitter
Tahoma Sans-Serif twitter
Timesnewroman Serif twitter
Trebuchet Ms Sans-Serif twitter
Verdana Sans-Serif twitter
Monaco Monospace twitter
External Fonts
Family Name Type Sample
Tektur Sans-Serif twitter

Expanding

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!

Filename Convention

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 the linkedin slug.
  • orcid-white_ORCID_FFF.svg - Creates an ORCID badge with white background (#FFF) and save it under the orcid-white slug.

License

MIT License

About

No description, website, or topics provided.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages