Shields.io: Quality metadata badges for open source projects

Pixel-perfect Retina-ready Fast Consistent Hackable No tracking

Love Shields? Please consider donating to sustain our activities

Other

Ansible Role:		`/ansible/role/:roleId`
AUR maintainer:		`/aur/maintainer/:packageName`
bit:		`/bit/collection/total-components/:owner/:collection`
bStats Players:		`/bstats/players/:pluginid`
bStats Servers:		`/bstats/servers/:pluginid`
Relative date:		`/date/:timestamp`
Eclipse Marketplace:		`/eclipse-marketplace/favorites/:name`
Gems:		`/gem/u/:user`
GitHub deployments:		`/github/deployments/:user/:repo/:environment`
GitHub manifest.json dynamic:		`/github/manifest-json/:key/:user/:repo`
GitHub manifest.json dynamic:		`/github/manifest-json/:key/:user/:repo/:branch`
GitHub manifest.json dynamic (path):		`/github/manifest-json/:key/:user/:repo?filename=extension%2Fmanifest.json`
GitHub manifest.json dynamic (path):		`/github/manifest-json/:key/:user/:repo/:branch?filename=extension%2Fmanifest.json`
GitHub package.json dynamic:		`/github/package-json/:key/:user/:repo`
GitHub package.json dynamic:		`/github/package-json/:key/:user/:repo/:branch`
Dependent repos (via libraries.io):		`/librariesio/dependent-repos/:platform/:packageName`
Dependent repos (via libraries.io), scoped npm package:		`/librariesio/dependent-repos/:platform/:scope/:packageName`
Dependents (via libraries.io):		`/librariesio/dependents/:platform/:packageName`
Dependents (via libraries.io), scoped npm package:		`/librariesio/dependents/:platform/:scope/:packageName`
Maintenance:		`/maintenance/:maintained/:year`
Offset Earth (Carbon Offset):		`/offset-earth/carbon/:username`
Offset Earth (Trees):		`/offset-earth/trees/:username`
OSS Lifecycle:		`/osslifecycle/:user/:repo`
OSS Lifecycle (branch):		`/osslifecycle/:user/:repo/:branch`
POEditor:		`/poeditor/progress/:projectId/:languageCode?token=abc123def456`
Puppet Forge modules by user:		`/puppetforge/mc/:user`
Puppet Forge releases by user:		`/puppetforge/rc/:user`
PyPI - Format:		`/pypi/format/:packageName`
PyPI - Status:		`/pypi/status/:packageName`
Sourceforge Open Tickets:		`/sourceforge/open-tickets/:project/:type`
Sourcegraph for Repo Reference Count:		`/sourcegraph/rrc/:repo`
Steam Collection Files:		`/steam/collection-files/:collectionId`
Steam Views:		`/steam/views/:fileId`
Swagger Validator:		`/swagger/valid/3.0?specUrl=https%3A%2F%2Fraw.githubusercontent.com%2FOAI%2FOpenAPI-Specification%2Fmaster%2Fexamples%2Fv2.0%2Fjson%2Fpetstore-expanded.json`
Treeware (Trees):		`/treeware/trees/:owner/:packageName`
Vaadin Directory:		`/vaadin-directory/status/:packageName`
Wheelmap:		`/wheelmap/a/:nodeId`

Your Badge

Static

Using dash "-" separator

https://img.shields.io/badge/<LABEL>-<MESSAGE>-<COLOR>

Dashes `--`	→	`-` Dash
Underscores `__`	→	`_` Underscore
`_` or Space	→	Space

Using query string parameters

https://img.shields.io/static/v1?label=<LABEL>&message=<MESSAGE>&color=<COLOR>

Colors

Endpoint

https://img.shields.io/endpoint?url=<URL>&style<STYLE>

Create badges from your own JSON endpoint.

Dynamic

https://img.shields.io/badge/dynamic/json?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

https://img.shields.io/badge/dynamic/xml?url=<URL>&label=<LABEL>&query=<//data/subdata>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

https://img.shields.io/badge/dynamic/yaml?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

Styles

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=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 (bitcoin, dependabot, discord, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. Simple-icons are referenced using names as they appear on the simple-icons site. If the name includes spaces, replace them with dashes (e.g: `?logo=visual-studio-code`)
`?logo=data:image/png;base64,…`	Insert custom logo image (≥ 14px high). There is a limit on the total size of request headers we can accept (8192 bytes). From a practical perspective, this means the base64-encoded image text is limited to somewhere slightly under 8192 bytes depending on the rest of the request header.
`?logoColor=violet`	Set the color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for named logos but not for custom logos.
`?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 server https://raster.shields.io. For example, the raster equivalent of https://img.shields.io/v/npm/express is https://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 it and we might bring it to you!

Community Status Metrics GitHub