Merkkigeneraattori (Shields-tyylinen SVG)
Esikatselu
SVG-koodi
Markdown (shields.io)
Markdown (itse isännöity SVG)
Lataa yllä oleva SVG, vie se repositorioosi (esimerkiksi nimellä badge.svg) ja viittaa siihen tällä suhteellisella polulla, jotta et ole riippuvainen shields.iosta.
HTML
reStructuredText
AsciiDoc
shields.io:n staattinen URL
Tekniset tiedot
Näin merkkigeneraattori toimii
Mitä merkkigeneraattori tekee
Merkkigeneraattori luo Shields-tyylisiä tilamerkkejä erillisinä SVG-tiedostoina. Syötä tunniste ja viesti, valitse värit (Shields-nimet kuten brightgreen, hex- tai rgb-arvot) ja yksi viidestä tyylistä: flat, flat-square, plastic, for-the-badge tai social. Tekstin leveydet arvioidaan Verdanan mittojen perusteella, jotta merkki sopii sisältöönsä, ja kaikki piirretään selaimessasi. Saat SVG-koodin, latauksen, vastaavan shields.io-URL:n ja liitettävät koodinpätkät.
Yleisiä käyttötapauksia
README-merkit tiivistävät koontiversion tilan, kattavuuden, version, lisenssin, tuetut alustat ja tuen. Käytä tätä työkalua, kun tarvitset oman merkin, jota shields.io ei tarjoa, merkin, jonka on toimittava offline-tilassa tai yksityisessä verkossa, tai repositorioon vietävän staattisen SVG:n, jotta dokumentaatio ei koskaan rikkoudu kolmannen osapuolen palvelun ollessa alhaalla. Esiasetukset build passing, MIT-lisenssi, versio, kattavuus ja PRs welcome antavat nopean alun.
Tulostusmuodot
Tuloste sisältää raaka-SVG:n, Markdownin shields.io-kuva-URL:llä, Markdownin, joka osoittaa itse isännöityyn badge.svg-tiedostoon, HTML img -tunnisteen, reStructuredTextin image-direktiivin ja AsciiDocin image-makron. Shields.io:n staattinen URL noudattaa dokumentoituja escape-sääntöjä: yhdysmerkki muuttuu kahdeksi yhdysmerkiksi, alaviiva kahdeksi alaviivaksi ja välilyönnit alaviivoiksi. URL luodaan vain tekstinä, eikä sitä koskaan pyydetä.
Yleisiä sudenkuoppia ja reunatapauksia
Värit, jotka eivät ole tunnistettu nimi, hex-arvo tai rgb()-kolmikko, ohitetaan ja käytetään oletusta, mikä estää markupin injektoinnin SVG:hen. Logojen on oltava base64-muotoisia SVG- tai PNG-data-URI:ita, ja ne upotetaan kuvina, ei koskaan raakana markupina. Merkin leveys on arvio, joten hyvin epätavalliset fontit tai ei-latinalainen teksti voivat näkyä hieman laatikkoa leveämpinä. GitHub tarjoaa repositorion SVG-tiedostot rajoittavalla sisältökäytännöllä, joten käytä raw-URL:ia tai shields.io-vaihtoehtoa upottaessasi repositorion ulkopuolelle.