GitHub package.json dev/peer/optional dependency version
If your GitHub badge errors, it might be because you hit GitHub's rate limits. You can increase Shields.io's rate limit by adding the Shields GitHub application using your GitHub account.
Path Parameters |
---|
user string — REQUIREDExample:
|
repo string — REQUIREDExample:
|
kind string — REQUIREDPossible values: [ Example:
|
packageName string — REQUIREDThis may be the name of an unscoped package like Example:
|
Query Parameters |
---|
filename stringExample:
|
style stringPossible values: [ If not specified, the default style for this badge is "flat". Example:
|
logo stringOne of the named logos (bitcoin, dependabot, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. All simple-icons are referenced using icon slugs. You can click the icon title on simple-icons to copy the slug or they can be found in the slugs.md file in the simple-icons repository. Further info. Example:
|
logoColor stringThe color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for named logos and Shields logos but not for custom logos. For multicolor Shields logos, the corresponding named logo will be used and colored. Example:
|
logoSize stringMake icons adaptively resize by setting Example:
|
label stringOverride the default left-hand-side text (URL-Encoding needed for spaces or special characters!) Example:
|
labelColor stringBackground color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). Example:
|
color stringBackground color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). Example:
|
cacheSeconds stringHTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored). Example:
|
link string[]Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an |