Shields badge specification, website and default API server
Go to file
2014-01-18 18:57:03 +01:00
ass-stubs Tests and coverage analysis. 2014-01-18 17:49:52 +01:00
img Font size increase. 2014-01-14 11:37:40 +01:00
web website: validated. 2014-01-17 17:44:09 +01:00
.buildpacks Node engine version information. Deployment files. 2014-01-03 19:25:49 +01:00
.gitignore Add SVGO to the pipeline 2014-01-02 18:25:34 +01:00
badge.js Using __dirname 2014-01-18 18:57:03 +01:00
colorscheme.json Better orange. 2014-01-06 15:28:05 +01:00
default-badges.json Remove generic ‘cheez whiz’ badge 2014-01-08 07:32:02 +01:00
gh-badge.js Using __dirname 2014-01-18 18:57:03 +01:00
make.js Separate color scheme data in its own file. 2014-01-03 16:27:18 +01:00
Makefile website: favicon. 2014-01-17 15:31:29 +01:00
package.json Tests and coverage analysis. 2014-01-18 17:49:52 +01:00
phantomjs-svg2png.js Local font loading into SVG in Phantom.js 2014-01-05 22:02:02 +01:00
README.md Clearer links. 2014-01-10 10:42:35 +01:00
server.js Tests and coverage analysis. 2014-01-18 17:49:52 +01:00
sheet.html Remove generic ‘cheez whiz’ badge 2014-01-08 07:32:02 +01:00
svg-to-img.js website: favicon. 2014-01-17 15:31:29 +01:00
template.svg Font size increase. 2014-01-14 11:37:40 +01:00
test.js Tests and coverage analysis. 2014-01-18 17:49:52 +01:00

GitHub badges in SVG format

npm version

Make your own badges (like this one above)!

Contribute

If you want to add a badge, you only need to modify default-badges.json.

The format is the following:

/* Unique name of your badge. */
"build-passed": {
  /* Textual information shown, in order. */
  "text": [ "build", "passed" ],
  "colorscheme": "green"
}

Color schemes are located in colorscheme.json. Each scheme has a name and a CSS/SVG color for the color used in the first box (for the first piece of text, field colorA) and for the one used in the second box (field colorB).

"green": {
  "colorB": "#4c1"
}

Both colorA and colorB have default values. Usually, the first box uses the same dark grey, so you can rely on that default value by not providing a "colorA" field (such as above).

You can also use the "colorA" and "colorB" fields directly in the badges if you don't want to make a color scheme for it. In that case, remove the "colorscheme" field altogether.

Requirements

Because of the usage of the npm module canvas you need to have cairo installed.

For more information check the wiki of the canvas project with system-specific installation details.

Making your Heroku badge server

Once you have installed the Heroku Toolbelt

heroku login
heroku create your-app-name
heroku config:set BUILDPACK_URL=https://github.com/mojodna/heroku-buildpack-multi.git#build-env
cp /path/to/Verdana.ttf .
make deploy
heroku open

Origin

See https://github.com/h5bp/lazyweb-requests/issues/150.

License

All work here is licensed CC0.