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 — REQUIREDThe URL to a file to search. The full raw content will be used as the search string. Example:
|
search string — REQUIREDA re2 expression that will be used to extract data from the document. Only the first matched text will be returned. Example:
|
replace stringA replacement string that will be used as the replacement of the search regex. Use Example:
|
flags stringFlags to be used when creating the regex: Example:
|
style stringPossible values: [ If not specified, the default style for this badge is "flat". Example:
|
logo stringIcon 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:
|
logoColor stringThe 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:
|
logoSize stringMake icons adaptively resize by setting Example:
|
label stringOverride the default left-hand-side text (URL-Encoding needed for spaces or special characters!) Example:
|
labelColor stringBackground color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). Example:
|
color stringBackground color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). Example:
|
cacheSeconds stringHTTP 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:
|
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 |