mirror of
https://github.com/badges/awesome-badges.git
synced 2025-07-21 13:01:23 +02:00
138 lines
7.2 KiB
Markdown
138 lines
7.2 KiB
Markdown
# Awesome Badges
|
|
|
|
[](https://awesome.re)
|
|
|
|
A curated collection of awesome things related to status badges.
|
|
|
|
_While this list is maintained by Paul Melnikow from the Shields core team, it
|
|
includes Shields-related and non-Shields-related resources._
|
|
|
|
### Dynamic badge services
|
|
|
|
- [Shields.io](https://shields.io/) – Original home of the badges,
|
|
launched in 2014.
|
|
- [Badgen.net](https://badgen.net/) – Fast badge generating service launched
|
|
in 2018.
|
|
- [NodeICO](https://nodei.co/) – Large-format status badges for Node.js
|
|
projects – which were once very popular!
|
|
- [PlayBadges](https://playbadges.pavi2410.me) – Show off your Play Store™ app's downloads and ratings in your repo
|
|
- [badge.fury.io](https://badge.fury.io) – Service for version badges of packages like PyPI, npm, RubyGems, etc.
|
|
- [dependents.info](https://dependents.info) – Showcase GitHub repository's network dependents with a badge and image.
|
|
|
|
### Badge tools
|
|
|
|
- [Badgie](https://badgie.me/) – Scans the contents of your repository and
|
|
adds badges based on what it finds.
|
|
- [Badges](https://github.com/bevry/badges) – Node.js/Deno/Browser npm package for rendering the HTML of various badges
|
|
- [Projectz](https://github.com/bevry/projectz) – Render Badges into your README based on your package.json configuration
|
|
- [shields.io Raycast extension](https://www.raycast.com/litomore/badges) – A more convenient UI for creating shields.io badges
|
|
- [shields-badge](https://github.com/galtzo-floss/shields-badge) – RubyGem for generating shields.io badge URLs and Markdown
|
|
|
|
### Raster badges
|
|
|
|
> SVG badges are encouraged because they render better on Retina displays and
|
|
> scale up beautifully. However in a few environments, such as Slack and HTML
|
|
> email, SVG images won't render, so PNG badges are preferred. Shields offers
|
|
> raster badges through its raster server, `raster.shields.io`.
|
|
|
|
- [svg-to-image-proxy](https://github.com/badges/svg-to-image-proxy) –
|
|
Rasterizing proxy based on Node and Puppeteer which can be hosted on Vercel.
|
|
(Since 2019 this code has been used to run `raster.shields.io`, however it's
|
|
about to be deprecated in favor of [squint](https://github.com/badges/squint/).)
|
|
- [squint](https://github.com/badges/squint/) – Rasterizing proxy based on
|
|
Rust and [libcairo](https://www.cairographics.org/).
|
|
|
|
### Static badges
|
|
|
|
- [For The Badge](https://forthebadge.com/) – Provides static badges
|
|
using a flat and boxy badge design which has become a classic. (This badge
|
|
format is available as `?style=for-the-badge` on Shields.io.)
|
|
|
|
### Static badge collections
|
|
|
|
- [Badges 4 README.md Profile](https://github.com/alexandresanlim/Badges4-README.md-Profile) – Catalog of Shields.io Badges for readme profiles
|
|
- [Project Types](https://project-types.github.io/) – Static badges for
|
|
four types of open-source project, as classified in Nadia Eghbal's
|
|
_Working in Public_.
|
|
- [Simple Badges](https://github.com/developStorm/simple-badges) – Catalog of Shields.io Badges with Simple Icons
|
|
- [Absurd badges](https://github.com/sebmestrallet/absurd-badges) – Collection of absurd, humorous, static badges
|
|
|
|
### Dynamic data providers
|
|
|
|
> Dynamic data providers are third parties who publish data APIs which can be
|
|
> used to back one of the dynamic badge services:
|
|
>
|
|
> - [Shields' Endpoint badge](https://shields.io/endpoint)
|
|
> - [Badgen's https badge](https://badgen.net/https)
|
|
> - [Badgen's RunKit endpoint badge](https://badgen.net/runkit)
|
|
|
|
- [Cell Shield](https://cellshield.info) – a service that allows backing a shields.io badge with a cell from a public Google Spreadsheet.
|
|
- [TYPO3 Badges](https://typo3-badges.dev) – API that provides
|
|
JSON endpoints to render badges of [TYPO3 CMS extensions](https://extensions.typo3.org/)
|
|
via Shields or Badgen.
|
|
- [Dynamic Badge Formatter](https://github.com/DenverCoder1/dynamic-badge-formatter) – Allows users to apply formatters for metrics, versions, dates, and more to dynamic shields.io badges to make them look consistent.
|
|
|
|
### Badge-rendering software
|
|
|
|
- [badge-maker](https://github.com/badges/shields/tree/master/badge-maker)
|
|
– JavaScript; supports plastic, flat, flat-square, for-the-badge, and
|
|
social styles. Powers Shields.io.
|
|
- [badgen](https://github.com/badgen/badgen) – TypeScript; supports classic
|
|
and flat. Powers Badgen.
|
|
- [gradient-badge](https://github.com/bokub/gradient-badge) – JavaScript;
|
|
generates gradient badges in classic and flat.
|
|
- [poser](https://github.com/badges/poser) – PHP.
|
|
- [pybadges](https://github.com/google/pybadges) – Python.
|
|
- [browser-support-badge](https://github.com/hustcc/browser-support-badge) –
|
|
JavaScript; generates browser version compatibility badges.
|
|
- [badge4j](https://github.com/silentsoft/badge4j) – Java.
|
|
|
|
### Icons
|
|
|
|
- [Simple Icons](https://simpleicons.org/) – Home of the bulk of the
|
|
icons used by both Shields and Badgen.
|
|
- [Custom Icon Badges](https://github.com/DenverCoder1/custom-icon-badges) – Allows users to more easily use Octicons and their own icons and logos on shields.io badges.
|
|
- [Simple Badges](https://badges.pages.dev/) – Website for finding and previewing Simple Icons on shields.io badges.
|
|
|
|
### Academic articles
|
|
|
|
- [Badges on npm packages](https://cmustrudel.github.io/projects/badges/)
|
|
– Data-driven assessment based on signaling theory applied to how
|
|
badges are used in npm.
|
|
[Published in ICSE 2018](https://cmustrudel.github.io/papers/icse18badges.pdf).
|
|
- [On the Usage of Badges in Open Source Packages on GitHub](http://ceur-ws.org/Vol-2605/9.pdf)
|
|
– Data-driven study of how status badges are used in Cargo and Packagist
|
|
projects.
|
|
|
|
### Historical articles
|
|
|
|
- [An Open Source Rage Diamond](https://olivierlacan.com/posts/an-open-source-rage-diamond/)
|
|
_(Jun. 5, 2014)_ – An article about the motivation for the Shields
|
|
project by one of its creators.
|
|
- [Shields badge specification](https://github.com/badges/shields/blob/master/spec/SPECIFICATION.md)
|
|
– Visual design specification for Shields.
|
|
|
|
### Talks
|
|
|
|
- [Shields.io by Nicco Kunzmann](https://www.youtube.com/watch?v=abBdk8bSPKU) –
|
|
A talk given by Nicco Kunzmann for I Love Free Software Day in Berlin,
|
|
Feb. 14, 2019.
|
|
- [Cool badges for your project by Marcin Mielnicki](https://raw.githubusercontent.com/hacktoberfest-poznan/presentations/master/2018/Cool-badges-for-your-project.pdf)
|
|
([photos](https://www.facebook.com/media/set/?vanity=hacktoberfest&set=a.258422348195183))
|
|
– A talk given by Shields core team member Marcin Mielnicki for
|
|
Hacktoberfest Poznań 2018.
|
|
|
|
### Hosting your own badge service
|
|
|
|
- [Shields self-hosting](https://github.com/badges/shields/blob/master/doc/self-hosting.md)
|
|
– Host your own copy of Shields to Heroku, Vercel, using Docker, or on a Node server.
|
|
- [Badgen self-hosting](https://github.com/badgen/badgen.net/#environments) –
|
|
Host your own copy of Badgen on Vercel.
|
|
|
|
### Achievement badges
|
|
|
|
- [Open Badges](https://openbadges.org/) – A specification for
|
|
verifiable digital badges.
|
|
- [Badgr](https://www.badgr.org/) – A service for creating verifiable
|
|
achievement badges, based on the Open Badges specification.
|