Skip to content

Custom Icon Badges

Allows users to more easily use Octicons and their own icons and logos on shields.io badges.

ref-reporef-online-tool

Tip

Since the project badges are generated based on shields.io, the configuration parameters can directly refer to shields.io badges. The following configurations only demonstrate the extended parameters for this project.

Parameters

Click to show/close parameters

NameTypeRequiredDefaultDescriptionMore Description
ref-params
shieldsIoParamsanytrueshields.io Badge path parametersFor example: badge/... (static badge) github/... (Github related).
ref-querys
hoststringimg.shields.ioUse different badge hosting serviceSupported: staging.shields.io img.shields.io.
logostringCustom icon nameThe name you set when uploading the icon.
logoSourcestringCustom icon sourceSupported: feather.
shieldsIoQuerysanyshields.io Badge query parametersFor example: logoColor (icon color) style (badge style) etc.
txt
https://custom-icon-badges.demolab.com/{shieldsIoParams}{?host,shieldsIoQuerys}

Examples

markdown
![Custom Icon Badge](https://custom-icon-badges.demolab.com/badge/custom-badge-blue.svg?logo=paintbrush&logoColor=white)
Custom Icon Badge

Badge Collection (v3.0.5) MIT Licensed