The definitive collection of badges for rendering
- Install:
npm install --save badges - Require:
require('badges')
<script type="module">
import * as pkg from '//dev.jspm.io/badges'
</script>This package is published with the following editions:
badgesaliasesbadges/index.jswhich uses Editions to automatically select the correct edition for the consumers environmentbadges/source/index.jsis esnext source code with require for modulesbadges/edition-browsers/index.jsis esnext compiled for browsers with require for modulesbadges/edition-node-0.8/index.jsis esnext compiled for node.js 0.8 with require for modules
This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to 5 or thereabouts. You can accomlish this via your tsconfig.json file like so:
{
"compilerOptions": {
"maxNodeModuleJsDepth": 5
}
}// Listing of badges to output
const list = [
// Custom Badges
['badge', {image: 'image', alt: 'alt'}],
['badge', {image: 'image', alt: 'alt', url: 'url', title: 'title'}],
['shields', {left: 'left', right: 'right', alt: 'alt', url: 'url', title: 'title'}],
['shields', {left: 'left', right: 'right', color: 'red', alt: 'alt', url: 'url', title: 'title'}],
'---',
// Development Badges
'npmversion',
'npmdownloads',
'daviddm',
'daviddmdev',
'nodeico',
'---',
// Testing Badges
'saucelabsbm',
'saucelabs',
'travisci',
'codeship',
'coveralls',
'codeclimate',
'bithound',
'waffle',
'---',
// Funding Badges
'sixtydevstips',
'patreon',
'opencollective',
'gratipay',
'flattr',
'paypal',
'bitcoin',
'wishlist',
'---',
// Social Badges
'slackinscript',
'slackin',
'gabeacon',
'googleplusone',
'redditsubmit',
'hackernewssubmit',
'facebooklike',
'facebookfollow',
'twittertweet',
'twitterfollow',
'githubfollow',
'githubstar',
'quorafollow'
]
// Configuration for the badges
const config = {
npmPackageName: 'badges',
saucelabsUsername: 'bevry',
saucelabsAuthToken: '123',
codeshipProjectUUID: '123',
codeshipProjectID: '123',
githubSlug: 'bevry/badges',
nodeicoQueryString: {downloads: true, compact: true, height: 2},
sixtydevstipsID: 'd2dcf439c9759e88f3ccec1cef394c10',
patreonUsername: 'bevry',
opencollectiveUsername: 'bevry',
gratipayUsername: 'bevry',
flattrUsername: 'balupton',
paypalURL: 'https://paypal.me/bevry',
paypalButtonID: 'QB8GQPZAH84N6', // another option instead of paypalURL
paypalUsername: 'bevry', // another option instead of paypalURL
bitcoinURL: 'https://bevry.me/bitcoin',
wishlistURL: 'https://bevry.me/wishlist',
slackinURL: 'https://slack.bevry.me',
gaTrackingID: 'UA-XXXXX-XX',
homepage: 'http://bevry.me',
facebookApplicationID: '123123',
facebookUsername: 'balupton',
twitterUsername: 'bevryme',
githubUsername: 'balupton',
quoraUsername: 'Benjamin-Lupton',
quoraRealname: 'Benjamin Arthur Lupton' // optional, will extract from username
}
// Options for rendering the badges
const options = {
// Filter Category
// When set to a string, will only render badges from the list that of the specified category
// Values can be 'development', 'testing', 'funding', or 'social'
// E.g. to render only funding badges, set to 'funding'
filterCategory: false,
// Filter Scripts
// When true, do not render any badges from the list that are scripts
filterScripts: false
}
// Render the badges to a string
const result = require('badges').renderBadges(list, config, options)
// Output the result
console.log(result)If you want to render badges inside your own project's readme files, check out the meta builder projectz which uses this package for badge rendering.
Discover the release history by heading on over to the HISTORY.md file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
If you there is a badge that you believe will be common enough for others to benefit from, send in a pull request. Each pull request should:
- Add the badge rendering code to the appropriate category section inside
source/badges.js - If your badge requires a script to run, it should have
badgeScript = true- see other badges for an example - Also remember to export your badge
- Add the badges test data to the test file
source/test.js - Add the badge configuration information to this readme file
README.md - Add the badge name to the
keywordfield ofpackage.json
These changes can be done in multiple commits or the same, it doesn't matter, as we will squash the commits on merge. We will also the changelog entry, so you don't need to do.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
Unless stated otherwise all works are:
- Copyright © 2015+ Bevry Pty Ltd
and licensed under:
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent