Shields.io

Concise, consistent, and legible badges in SVG and raster format.

Tip

Due to the large number of badge types supported by this project and its powerful functions, here is a simple introduction to static badges. For other badge types, please refer to the official documentation.

Parameters

Click to show/close parameters

Name	Type	Required	Default	Description	More Description
badgeContent	string	true		Label, (optional) message, and color. Separated by dashes	Example: build-passing-brightgreen.
style	string		flat	Badge style	Possible values: flat flat-square plastic for-the-badge social.
logo	string			Icon slug from simple-icons	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.
logoColor	string			The color of the logo	Supported: hex, rgb, rgba, hsl, hsla and css named colors. Supported for simple-icons logos but not for custom logos.
logoSize	string			Make icons adaptively resize by setting auto	Useful for some wider logos like amd and amg. Supported for simple-icons logos but not for custom logos.
label	string			Override the default left-hand-side text	URL-Encoding needed for spaces or special characters!.
labelColor	string			The color of the logo	Supported: hex, rgb, rgba, hsl, hsla and css named colors. Supported for simple-icons logos but not for custom logos.
color	string			Background color of the right part	Supported: hex, rgb, rgba, hsl, hsla and css named colors.
cacheSeconds	string		3600	HTTP cache lifetime	Unit: seconds. Rules are applied to infer a default value on a per-badge basis. Any values specified below the default will be ignored.
link	string			Specify the action to perform when clicking the left/right side of the badge	Note: This only works when integrating your badge in an <object> HTML tag, but not an <img> tag or a markup language.

https://img.shields.io/badge/{badgeContent}{?style,logo,logoColor,logoSize,label,labelColor,color,cacheSeconds,link}

Examples

<!-- badges/shields -->
![Static Badge](https://img.shields.io/badge/badges/shields-555555?logo=github)

![Color Badge](https://img.shields.io/badge/F94144-F94144)