-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathshields.io.images.txt
47 lines (34 loc) · 2.71 KB
/
shields.io.images.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
┏━━━━━━━━━━━━━━━━┓
┃ SHIELDS.IO ┃
┗━━━━━━━━━━━━━━━━┛
GOAL ==> #Website that hosts automatically generated badge icons for public repos:
COLOR #HEX|RGB[A]|HSL[A]|NAME
https://img.shields.io/... #For everything below
/PATH.svg[?VAR=VAL] #Supported projects are documented in their respective documentations
/badge/LABEL-STATUS-COLOR.svg #Personalized badge
#Escaping: - -> -- and space -> _ and _ -> __
/badge/dynamic/FORMAT.svg?url=URL& #Use JSONPATH|XPATH on response from HTTP request to GET URL
query=JSONPATH # - uses dchester jsonpath
# - transtype with JavaScript `String()`
#FORMAT can be json|xml|yaml
#Other parameters:
# - label LABEL (def: "custom badge")
# - color COLOR (def: "green")
# - prefix|suffix STR (def: ""): prepended|appended to value
?style=STR #plastic, flat (def), flat-square, for-the-badge, social
?label=LABEL #Overrides it (must be URI encoded)
?colorA|colorB=COLOR #For left|right part
?link=URI #When set twice, is for left part and right part
?logo=PNG_DATA_URI|NAME #Logo
#Can use any name from package "simple-icons" and also many popular tech projects (including npm, github)
#Minimum 14px
?logoColor=COLOR #
?logoWidth=NUM #
?maxAge=NUM #HTTP unconditional caching. Def: 120, min 120, in secs
EXTENSION ==> #Can replace extension .svg by .png
NEW PROJECT ==> #Can open issues on their GitHub page to ask for badges for own project.
/website-up-down-green-orange/URL.svg #Shows if website is up
#URL: SCHEME:// -> SCHEME/
/maintenance/yes|no/YYYY.svg #Shows whether maintained
/stackexchange/TOPIC/t/951.svg #StackExchange reputation
/stackexchange/stackoverflow/t/TOPIC.svg #Number of StackOverflow questions