Making GitHub Repos Nice
Shields.io
reading surface
Technology
Shields from GitHub
Permalink to Shields from GitHublast commit badge is underrated, it's a great way to see if a project is still maintained or not. others include release, stars, forks, watchers, license, etc.
for repo utkarshkukreti/markup.rs, the badges are:
Static Badges
Permalink to Static BadgesIt is possible to use shields.io to make a wide variety of badges displaying static text and/or logos. For example:
plate / optimizedany text you like plate / optimizedjust the message plate / optimized'for the badge' style plate / optimizedwith a logo
For more info, see:
Logos
Permalink to LogosSimpleIcons
Permalink to SimpleIconsWe support a wide range of logos via SimpleIcons. All simple-icons are referenced using icon slugs. e.g:
You can click the icon title on simple-icons to copy the slug or they can be found in the slugs.md file in the simple-icons repository. NB - the Simple Icons site and slugs.md page may at times contain new icons that haven't yet been pulled into Shields.io yet. More information on how and when we incorporate icon updates can be found here.
Shields logos
Permalink to Shields logosWe also maintain a small number of custom logos for a handful of services: They can also be referenced by name and take preference to SimpleIcons e.g:
Custom Logos
Permalink to Custom LogosAny custom logo can be passed in a URL parameter by base64 encoding it. e.g:
logoColor parameter
Permalink to logoColor parameterThe logoColor param can be used to set the color of the logo. Hex, rgb, rgba, hsl, hsla and css named colors can all be used. For SimpleIcons named logos (which are monochrome), the color will be applied to the SimpleIcons logo.
plate / optimized plate / optimized
In the case where Shields hosts a custom multi-colored logo, if the logoColor param is passed, the corresponding SimpleIcons logo will be substituted and colored.
plate / optimized plate / optimized
Static Badge
Permalink to Static BadgeThe static badge accepts a single required path parameter which encodes either:
- Label, message and color separated by a dash -. For example:
plate / optimizedany text: you like
- Message and color only, separated by a dash -. For example:
plate / optimizedjust the message
| URL input | Badge output |
|------------------------|--------------|
| Underscore _ or %20 | Space `` |
| Double underscore __ | Underscore _ |
| Double dash -- | Dash - |
Hex, rgb, rgba, hsl, hsla and css named colors may be used.
Path Parameters
Permalink to Path ParametersbadgeContent string — REQUIRED
Label, (optional) message, and color. Separated by dashes
Example: build-passing-brightgreen
Query Parameters
Permalink to Query Parameters-
stylestring- One of: flat (default), flat-square, plastic, for-the-badge, social
- Example: flat
-
logostring- One of the named logos (bitcoin, dependabot, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. All simple-icons are referenced using icon slugs. You can click the icon title on simple-icons to copy the slug or they can be found in the slugs.md file in the simple-icons repository. Further info.
- Example: appveyor
-
logoColorstring- The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for named logos and Shields logos but not for custom logos. For multicolor Shields logos, the corresponding named logo will be used and colored.
- Example: violet
-
labelstring -
Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!)
-
Example: healthiness
-
labelColorstring- Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).
- Example: abcdef
-
colorstring- Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).
- Example: fedcba
-
cacheSecondsstring- HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).
- Example: 3600
-
linkstring[]- Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an
<object>HTML tag, but not an<img>tag or a markup language
- Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an