Badges are an elegant way to display useful information in your project description, source page and other spaces.
It also offers you show quick stats and numbers if you like (we know you do!)

This article is based on the cool guide which was written by the popular author way2muchnoise who kindly agree for us to share this documentation here.


Usage

The base url is https://cf.way2muchnoise.eu. This url can be appended by following patterns. Use of https is available, but GitHub doesn't seem to like that. The examples below are but a subset of all possibilities go check out the code on Github for all possible options


/<project>.svg

project being either the id or name(link in the url).


-> https://cf.way2muchnoise.eu/240630.svg

-> https://cf.way2muchnoise.eu/jei.svg


/<style>_<project>_<extra>.svg

style can either 'short' or 'full', extra is optional text to be appended.


-> https://cf.way2muchnoise.eu/short_jei.svg

-> https://cf.way2muchnoise.eu/full_240630_downloads.svg


/versions/<project>.svg

project being either the id or name(link in the url)


 -> https://cf.way2muchnoise.eu/versions/jei.svg

-> https://cf.way2muchnoise.eu/versions/240630.svg


/versions/<text>_<project>_<style>.svg

text is optional and replaces the default 'Available for' text. The style can be either 'all' or 'latest'


-> https://cf.way2muchnoise.eu/versions/jei_latest.svg

-> https://cf.way2muchnoise.eu/versions/For%20MC_240630_all.svg


/author/<name>.svg

author being either or name(link in the url).


-> https://cf.way2muchnoise.eu/author/way2muchnoise.svg

-> https://cf.way2muchnoise.eu/author/mezz.svg


/author/<style>_<name>_<extra>.svg

style can either 'short' or 'full', extra is optional text to be appended.


 -> https://cf.way2muchnoise.eu/author/short_mezz.svg

-> https://cf.way2muchnoise.eu/author/full_way2muchnoise_downloads.svg


/title/<project>.svg

project being either the id or name(link in the url).


-> https://cf.way2muchnoise.eu/title/jei.svg

-> https://cf.way2muchnoise.eu/title/240630.svg


/title/<project>_<prefix>_<suffix>.svg

project being either the id or name(link in the url), prefix and suffix are added are the added text.


 -> https://cf.way2muchnoise.eu/title/jei_Get_Today!.svg

-> https://cf.way2muchnoise.eu/title/240630_%20_Is%20Awesome!.svg


Different badge styles

Using the get param badge_style allows for changing the badge style. Currently the only alternative options are for_the_badge,flat


-> https://cf.way2muchnoise.eu/240630.svg

-> https://cf.way2muchnoise.eu/240630.svg?badge_style=for_the_badge

-> https://cf.way2muchnoise.eu/240630.svg?badge_style=flat