2.3 KiB
Luzifer / badge-gen
Ever ran into this scenario? You wanted to add a link to something to your GitHub project using a nice button like the Godoc or the Travis-CI button but you was not able to find a button for this having the text you wanted? I did. I wanted to add a button "API Documentation" to one of my projects and did not find any button with that caption. So I wrote it myself.
And I wasn't myself if I would allow me to do the same work twice or more often so I wrote a small webserver able to generate those buttons with a customizable text in SVG (I did not care about older browser since long ago)…
Usage
Using my version
Simple use the raw-API URL below or one of the URLs listed on the demo page:
https://badges.fyi/static/API/Documentation/4c1
Parameters title and text are free-text strings while color has to be 3- or 6-letter hex notation for colors like that one you use in CSS.
To embed them into Markdown pages like this README.md:
Using your own hosted version
- There is a Docker container for it. Just start it and use your own URL
For configuration options see config.md. These need to be supplied in a YAML file:
---
key: value
...
Popular buttons rebuilt
Hint: To get the source just look into the source of this README.md
Yeah, sure you even could fake your Travis-CI build status but seriously: Why should you do that? Shame on you if you do!