Generator značk (SVG v slogu Shields)
Predogled
Koda SVG
Markdown (shields.io)
Markdown (SVG na lastnem gostovanju)
Prenesite zgornji SVG, ga potrdite v svoj repozitorij (na primer kot badge.svg) in se nanj sklicujte s to relativno potjo, da ne boste odvisni od shields.io.
HTML
reStructuredText
AsciiDoc
Statični URL shields.io
Tehnične podrobnosti
Kako deluje generator značk
Kaj počne generator značk
Generator značk ustvarja statusne značke v slogu shields kot samostojne datoteke SVG. Vnesite oznako in sporočilo, izberite barve (imena shields, kot je brightgreen, vrednosti hex ali rgb) in enega od petih slogov: flat, flat-square, plastic, for-the-badge ali social. Širine besedila so ocenjene po meritvah pisave Verdana, tako da značka ustreza vsebini, vse pa se izriše v vašem brskalniku. Dobite kodo SVG, prenos, enakovreden URL shields.io in izseke, pripravljene za lepljenje.
Pogosti primeri uporabe
Značke README povzemajo stanje gradnje, pokritost, različico, licenco, podprte platforme in sponzorstvo. Orodje uporabite, kadar želite značko po meri, ki je shields.io ne ponuja, značko, ki mora delovati brez povezave ali v zasebnem omrežju, ali statični SVG, potrjen v repozitorij, da se dokumentacija nikoli ne pokvari, ko storitev tretje osebe ne deluje. Prednastavitve za build passing, licenco MIT, različico, pokritost in PRs welcome omogočajo hiter začetek.
Izhodni formati
Izhod vsebuje surov SVG, Markdown z URL slike shields.io, Markdown, ki kaže na lastni badge.svg, oznako HTML img, direktivo image za reStructuredText in makro image za AsciiDoc. Statični URL shields.io sledi dokumentiranim pravilom ubežnih zaporedij: ena pomišljaj postane dva pomišljaja, eno podčrtaj postane dva podčrtaja, presledki pa postanejo podčrtaji. URL se ustvari samo kot besedilo in se nikoli ne pokliče.
Pogoste pasti in robni primeri
Barve, ki niso prepoznano ime, vrednost hex ali trojček rgb(), se prezrejo in uporabi se privzeta, kar preprečuje vstavljanje označb v SVG. Logotipi morajo biti SVG ali PNG data URI v base64 in so vdelani kot slike, nikoli kot surove označbe. Širina značke je približek, zato se zelo nenavadne pisave ali nelatinično besedilo lahko izrišejo nekoliko širše od okvirja. GitHub streže SVG iz vašega repozitorija z omejevalno politiko vsebine, zato za vdelavo zunaj repozitorija uporabite raw URL ali različico shields.io.