Allows users to more easily use their own icons and logos to shields.io badges.
-
Get a badge URL from shields.io.
-
Replace
img.shields.io
withcustom-icon-badges.herokuapp.com
-
Use any available slug as the logo query parameter.
https://custom-icon-badges.herokuapp.com/badge/custom-badge-blue.svg?logo=paintbrush&logoColor=white
Preview:
The following are examples of existing icons and logos that are already available.
Currently all Octicons are supported.
Slug | Example |
---|---|
issue-opened |
|
repo-forked |
|
star |
|
git-commit |
|
repo |
|
git-pull-request |
|
heart |
|
mail |
|
More Octicons | View all โจ |
Slug | Example |
---|---|
ceylon |
|
color-swatch |
|
controller |
|
issue |
|
fire |
|
flag |
|
translate |
|
trending-up |
|
trending-down |
|
phone |
|
swi-prolog |
|
Add your own | Upload icon โจ |
Upload new icons using the demo site!
The file type can be SVG, PNG, etc. but only SVG format supports the logoColor
parameter for overriding the color of the logo.
If you think your icon is useful to others, feel free to open a PR to add it to the README above!
Demo site: https://custom-icon-badges.herokuapp.com
Click to get the URL!
We welcome contributions!
Please see CONTRIBUTING.md for details.
Deploying on your own is optional. See the steps below.
Deploy to Heroku
- Sign in to Heroku or create a new account at https://heroku.com
- Click the Deploy button below
- Add the url of a Mongo database as the
DB_URL
config var. The database should have a collection calledicons
. See getting started for more info on setting up a free Mongo Atlas database.
- Click "Deploy App" at the end of the form
- Once the app is deployed, you can use
<your-app-name>.herokuapp.com
in place ofcustom-icon-badges.herokuapp.com
Feel free to open an issue.
๐ If you like this project, give it a โญ and share it with friends!
Made with โค๏ธ and TypeScript