Merit

Fast badge generator for any purpose

Usage

Web

Usage:

    https://merit-badge.dev/badge/{subject}[/{text}][?params]

Path:
    /subject         string
    /text (Optional) string. Text can also be comma separated numbers for sparkline

Query Params:
    color       badge color. Must be a valid css color
    icon        icon can be any "Brand" or "Solid" icons from fontawesome
    icon_color  icon color. Must be a valid css color
    style       [possible values: flat, classic] defaults to classic
    size        [possible values: large, medium, small] defaults to small

Badge with only subject	https://merit-badge.dev/badge/subject
Default badge	https://merit-badge.dev/badge/subject/text
Badge with medium size	https://merit-badge.dev/badge/size/medium?size=medium
Badge with large size	https://merit-badge.dev/badge/size/large?size=large
Red badge	https://merit-badge.dev/badge/color/red?color=ff0000
Badge with brand icon	https://merit-badge.dev/badge/icon/brand?icon=npm
Badge with solid icon	https://merit-badge.dev/badge/icon/solid?icon=code
Badge with sparkline chart	https://merit-badge.dev/badge/data/1,5,2,4,8,3,7
Flat badge	https://merit-badge.dev/badge/style/flat?style=flat

Icon cany be any Brand or Solid icons from fontawesome Color can be any 6 or 8 digit hex color, a valid css color name or RGB / RGBA color

URL

Generate live badges from your own endpoint.

Text badge	https://merit-badge.dev/url/https://b5vhr8tsmbj6.runkit.sh/allText
Data badge	https://merit-badge.dev/url/https://b5vhr8tsmbj6.runkit.sh/allData
badge with only subject	https://merit-badge.dev/url/https://b5vhr8tsmbj6.runkit.sh/subject
default badge with text	https://merit-badge.dev/url/https://b5vhr8tsmbj6.runkit.sh/withText
Medium size badge	https://merit-badge.dev/url/https://b5vhr8tsmbj6.runkit.sh/mediumSize
Large size badge	https://merit-badge.dev/url/https://b5vhr8tsmbj6.runkit.sh/largeSize
Red badge	https://merit-badge.dev/url/https://b5vhr8tsmbj6.runkit.sh/red
badge with brand icon	https://merit-badge.dev/url/https://b5vhr8tsmbj6.runkit.sh/iconBrand
badge with solid icon	https://merit-badge.dev/url/https://b5vhr8tsmbj6.runkit.sh/iconSolid
Chart badge	https://merit-badge.dev/url/https://b5vhr8tsmbj6.runkit.sh/data
Flat badge	https://merit-badge.dev/url/https://b5vhr8tsmbj6.runkit.sh/flat

Usage:

    https://merit-badge.dev/url/{http-endponint}[?params]

Path:
    http-endponint : An HTTP GET endpoint that returns following JSON
    {
        text?: string
        subject: string
        style?: "Flat" | "Classic"
        size?: "Large" | "Medium" | "Small"
        color?: string // Can be any valid CSS color
        icon?: string // Icon can be any "Brand" or "Solid" icons from fontawesome
        icon_color?: string // Can be any valid CSS color
        data?: number[]
    }

Query Params:
    color       Any valid css color. Supports Color name, RGB and hex
    icon        Icon can be any "Brand" or "Solid" icons from fontawesome
    icon_color  Any valid css color. Supports Color name, RGB and hex
    style       [possible values: flat, classic] defaults to classic
    size        [possible values: large, medium, small] defaults to small

Query params take presidence if any option is passed in both query param and endpoint.

Runkit example

CLI

❯ badge --help
Usage: badge -s <subject> [--style <style>] [--size <size>] [--color <color>] [--icon <icon>] [--icon-color <icon-color>] [--out <out>] [-t <text>] [--data <data>]

Fast badge generator for any purpose

Options:
  -s, --subject     badge subject
  --style           badge style. [possible values: flat | f, classic | c]
  --size            badge size. [possible values: large | l, medium | m, small | s]
  --color           badge color. Must be a valid css color
  --icon            badge icon. icon can be any Brand or Solid icons from fontawesome
  --icon-color      icon color. Must be a valid css color
  --out             output svg to file
  -t, --text        badge text
  --data            data for badge chart.
  --help            display usage information