Get Started ​
Edit the URL or add query Parameters, then click outside the box to see the changes.
Click to View Available Links and Badges
đź’ˇ Tip: Click on a link to auto-fill the box or add ?color=red
- /ghcr/size/{owner}/{package}
- /ghcr/tags/{owner}/{package}/latest
- /ghcr/tags/{owner}/{package}
- /yaml/{url}/{path}
- /json/{url}/{path}
- /static/{message}
- /static/{message}/{label}
- /vt/id/{sha}
- /vt/{owner}/{repo}/{asset}
- /vt/{owner}/{repo}/{asset}/{tag}
Show URL Encode Tool
đź’ˇ Tip: Clicking on the result copies it to the clipboard.
Parameters ​
These parameters are available for all badges.
| Parameter | Default Param Value | Description of the Parameter |
|---|---|---|
style | flat | plastic, flat, flat-square, for-the-badge, social |
color | brightgreen | Badge Background Color (right side) |
labelÂą | badge specific | Label Text (left side) |
labelColor | #555 | Label Background Color (left side) |
iconÂą | badge specific | Name of a Simple Icon |
lucide | badge specific | Name of a Lucide Icon |
iconColor | #fff | Icon Color |
Âą Allowed Empty. Set to an empty value to remove it from the badge.
For more details see the documentation for the related library, badge-maker.
Badge Specific ​
These parameters are specific to certain badges.
| Parameter | Example | Description of the Parameter |
|---|---|---|
n | 3 | Number of items to include in the badge. |
sep | | | List item seperator where applicable. |
semver | - | Filter items by valid semantic versions. |
reversed | - | Reverse the order of returned items. |
split | - | Split the item at the delimiter. |
index | 0 | Index of item after splitting. |
Purge Cache ​
You can purge the server cache by sending a PURGE/POST request to the badge URL.
Results: Awaiting Purge
Â
Work in Progress
These docs are not yet complete. See the README.md on GitHub for more details.
