Pixel-perfect Retina-ready Fast Consistent Hackable No tracking
https://img.shields.io/badge/<SUBJECT>-<STATUS>-<COLOR>.svg
Dashes -- | → | - Dash |
Underscores __ | → | _ Underscore |
_ or Space | → | Space |
https://img.shields.io/badge/endpoint.svg?url=<URL>&style<STYLE>
Create badges from your own JSON endpoint.
https://img.shields.io/badge/dynamic/json.svg?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&colorB=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>
https://img.shields.io/badge/dynamic/xml.svg?url=<URL>&label=<LABEL>&query=<//data/subdata>&colorB=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>
https://img.shields.io/badge/dynamic/yaml.svg?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&colorB=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>
The following styles are available. Flat is the default. Examples are shown with an optional logo:
?style=plastic&logo=appveyor | |
?style=flat&logo=appveyor | |
?style=flat-square&logo=appveyor | |
?style=for-the-badge&logo=appveyor | |
?style=popout&logo=appveyor | |
?style=popout-square&logo=appveyor | |
?style=social&logo=appveyor |
Here are a few other parameters you can use: (connecting several with "&" is possible)
?label=healthinesses | Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!) |
?logo=appveyor | Insert one of the named logos from (appveyor, azuredevops, bitcoin, circleci, codeship, dependabot, discord, docker, eclipse, github, gitlab, gitter-white, lgtm, liberapay, matrix, npm, paypal, postgresql, scrutinizer, serverfault, slack, sourcegraph, stackexchange, stackoverflow, superuser, telegram, tfs, travis, twitter, windows) or simple-icons |
?logo=data:image/png;base64,… | Insert custom logo image (≥ 14px 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) |
?colorA=abcdef | Set background of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported) |
?colorB=fedcba | Set background of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported) |
?maxAge=3600 | Set the HTTP cache lifetime in secs (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored) |
We support .svg, .json, .png and a few others, but use them responsibly.
What is your favorite badge service to use?
Tell us and we might bring it to you!