Static Badge
The static badge accepts a single required path parameter which encodes either:
- Label, message and color seperated by a dash
-
. For example:
-https://img.shields.io/badge/any_text-you_like-blue - Message and color only, seperated by a dash
-
. For example:
-https://img.shields.io/badge/just%20the%20message-8A2BE2
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 |
---|
badgeContent string — REQUIREDLabel, (optional) message, and color. Seperated by dashes Example: build-passing-brightgreen |
Query Parameters |
---|
style stringOne of: flat (default), flat-square, plastic, for-the-badge, social Example: flat |
logo stringOne 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. Example: appveyor |
logoColor stringThe 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 |
label stringOverride the default left-hand-side text (URL-Encoding needed for spaces or special characters!) Example: healthiness |
labelColor stringBackground color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). Example: abcdef |
color stringBackground color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). Example: fedcba |
cacheSeconds stringHTTP 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 |
link string[]Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an |