Love Shields? Please consider
donatingto sustain our activities
Static
Using dash “-” separator
https://img.shields.io/badge/
Dashes – | → | - (Dash) |
Underscores (__) | → | _ Underscore |
(_) ******************************************* (or Space) |
→ | (Space) |
Using query string parameters
https://img.shields.io / static / v1? label=
Colors
(Endpoint) https://img.shields.io/endpoint?url=
Create badges fromyour own JSON endpoint.
(Dynamic) *************************************
https://img.shields.io/badge/dynamic/json?url=
https://img.shields.io/badge/dynamic/xml?url=
https://img.shields.io/badge/d ynamic / yaml? url=
Styles
following styles are available. Flat is the default. Examples are shown with an optional logo:
Here are a few other parameters you can use: (connecting several with “&” is possible)
? label=healthinesses |
Override the default left-hand-side text (URL-Encodingneeded for spaces or special characters!) |
? logo=appveyor |
Insert one of the named logos from (bitcoin,Dependabot,discord,gitlab,npm,Paypal,serverfault,stackexchange,superuser,telegram, (travis) ) orsimple-icons. Simple-icons are referenced using names as they appear on the simple-icons site. If the name includes spaces, replace them with dashes (eg:? logo=visual-studio-code ) |
? logo=data: image / png; base 64,… |
Insert custom logo image (≥ 14 px high) |
? logoColor=violet |
Set the color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported) |
? logoWidth=40 |
Set the horizontal space to give to the logo |
? link=http: // left & link=http: // right |
Specify what clicking on the left / right of a badge should do (esp. for social badge style) |
? labelColor=abcdef |
Set background of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name “colorA” is also supported. |
? color=fedcba |
Set background of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name “colorB” is also supported. |
? cacheSeconds=3600 |
Set the 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). The legacy name “maxAge” is also supported. |
We support.SVG
and.JSON
. The default is. Svg
, which can be omitted from the URL.
While we highly recommend using SVG, we also support.png
for use cases where SVG will not work. These requests should be made to our raster serverhttps://raster.shields.io
. For example, the raster equivalent ofhttps: //img.shields.io/v/npm/express
ishttps://raster.shields.io/v/npm/express
. For backward compatibility, the badge server will redirect.png
badges to the raster server.
Like This?
Have an idea for an awesome new badge?
Tell us about itand we might bring it to you!
GIPHY App Key not set. Please check settings