Skip to main content

Dynamic Regex Badge

⚠️ Experimental: This badge is considered experimental and may change or be removed at any time.

This badge will extract text from a file using re2 (a subset of regex: https://github.com/google/re2). The main use-case is to extract values from unstructured plain-text files. For example: if a file contains a line like version - 2.4 you can extract the value 2.4 by using a search regex of version - (.*) and $1 as replacement.

Full Syntax documentation here: https://github.com/google/re2/wiki/Syntax

Query Parameters
url string REQUIRED

The URL to a file to search. The full raw content will be used as the search string.

Example: https://raw.githubusercontent.com/badges/shields/refs/heads/master/README.md

search string REQUIRED

A re2 expression that will be used to extract data from the document. Only the first matched text will be returned.

Example: Every (.*?) it serves (?<amount>.*?) images

replace string

A replacement string that will be used as the replacement of the search regex. Use $$ to escape a $ sign, $n to specify the nth matched group, $<name> for a named group, etc. If empty (default), no replacement will be done and the full matched text will be shown.

Example: $<amount>/$1

flags string

Flags to be used when creating the regex: i = case-insensitive, m = multi-line mode, s = dot matches linebreaks. None by default.

Example: ims

style string

Possible values: [flat, flat-square, plastic, for-the-badge, social]

If not specified, the default style for this badge is "flat".

Example: flat

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.

Example: appveyor

logoColor string

The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.

Example: violet

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.

Example: auto

label string

Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!)

Example: healthiness

labelColor string

Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).

Example: abcdef

color string

Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).

Example: fedcba

cacheSeconds string

HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).

Example: 3600

link string[]

Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an <object> HTML tag, but not an <img> tag or a markup language.