Generátor odznakov (SVG v štýle Shields)
Náhľad
Kód SVG
Markdown (shields.io)
Markdown (vlastne hostované SVG)
Stiahnite SVG vyššie, commitnite ho do svojho repozitára (napríklad ako badge.svg) a odkazujte naň relatívnou cestou, aby ste nezáviseli od shields.io.
HTML
reStructuredText
AsciiDoc
Statická URL shields.io
Technické podrobnosti
Ako funguje generátor odznakov
Čo robí generátor odznakov
Generátor odznakov vytvára stavové odznaky v štýle shields ako samostatné súbory SVG. Zadajte popis a správu, vyberte farby (názvy shields ako brightgreen, hodnoty hex alebo rgb) a jeden z piatich štýlov: flat, flat-square, plastic, for-the-badge alebo social. Šírky textu sa odhadujú z metrík Verdana, aby odznak zodpovedal obsahu, a všetko sa vykresľuje vo vašom prehliadači. Získate kód SVG, stiahnutie, zodpovedajúcu URL shields.io a úryvky pripravené na vloženie.
Bežné prípady použitia
Odznaky v README zhŕňajú stav buildu, pokrytie, verziu, licenciu, podporované platformy a sponzorstvo. Použite tento nástroj, keď chcete vlastný odznak, ktorý shields.io neponúka, keď musí odznak fungovať offline alebo v súkromnej sieti, alebo keď sa statické SVG commituje do repozitára, aby sa dokumentácia nikdy nerozbila kvôli výpadku služby tretej strany. Predvoľby build passing, MIT license, version, coverage a PRs welcome vám umožnia rýchly štart.
Výstupné formáty
Výstup zahŕňa surové SVG, Markdown s URL obrázka shields.io, Markdown odkazujúci na vlastne hostovaný badge.svg, značku HTML img, direktívu image z reStructuredText a makro image z AsciiDoc. Statická URL shields.io dodržiava zdokumentované pravidlá únikov: pomlčka sa stane dvoma pomlčkami, podčiarkovník dvoma podčiarkovníkmi a medzery sa zmenia na podčiarkovníky. URL sa iba generuje ako text a nikdy sa nevyžaduje.
Bežné úskalia a hraničné prípady
Farby, ktoré nie sú rozpoznaným názvom, hodnotou hex ani trojicou rgb(), sa ignorujú a použije sa predvolená, čo bráni vkladaniu značiek do SVG. Logá musia byť data URI base64 vo formáte SVG alebo PNG a vkladajú sa ako obrázky, nikdy ako surové značky. Šírka odznaku je odhad, takže veľmi nezvyčajné písma alebo nelatinský text sa môžu vykresliť o niečo širšie než rámček. GitHub servíruje SVG z vášho repozitára s prísnou politikou obsahu, preto pri vkladaní mimo repozitára použite raw URL alebo variant shields.io.