Generátor odznaků (SVG ve stylu Shields)
Náhled
Kód SVG
Markdown (shields.io)
Markdown (SVG hostované u vás)
Stáhněte výše uvedené SVG, přidejte ho do repozitáře (například jako badge.svg) a odkažte na něj touto relativní cestou, abyste nebyli závislí na shields.io.
HTML
reStructuredText
AsciiDoc
Statická URL shields.io
Technické detaily
Jak funguje generátor odznaků
Co generátor odznaků dělá
Generátor odznaků vytváří stavové odznaky ve stylu shields jako samostatné soubory SVG. Zadejte popisek a zprávu, vyberte barvy (názvy shields jako brightgreen, hodnoty hex nebo rgb) a jeden z pěti stylů: flat, flat-square, plastic, for-the-badge nebo social. Šířka textu se aproximuje podle metrik fontu Verdana, aby odznak odpovídal obsahu, a vše se vykresluje ve vašem prohlížeči. Získáte kód SVG, stažení, odpovídající URL shields.io a hotové úryvky ke vložení.
Typické případy použití
Odznaky v README shrnují stav sestavení, pokrytí, verzi, licenci, podporované platformy a sponzoring. Použijte tento nástroj, když chcete vlastní odznak, který shields.io nenabízí, odznak, který musí fungovat offline nebo v privátní síti, nebo statické SVG v repozitáři, aby se dokumentace nerozbila při výpadku služby třetí strany. Předvolby build passing, licence MIT, verze, coverage a PRs welcome vám usnadní start.
Výstupní formáty
Výstup zahrnuje surové SVG, Markdown s URL obrázku ze shields.io, Markdown odkazující na vlastní hostovaný badge.svg, HTML značku img, direktivu image pro reStructuredText a makro image pro AsciiDoc. Statická URL shields.io se řídí zdokumentovanými pravidly escapování: pomlčka se změní na dvě pomlčky, podtržítko na dvě podtržítka a mezery na podtržítka. URL se pouze generuje jako text a nikdy se nevolá.
Časté úskalí a okrajové případy
Barvy, které nejsou rozpoznaným názvem, hodnotou hex ani trojicí rgb(), se ignorují a použije se výchozí, což brání vložení značek do SVG. Loga musí být data URI SVG nebo PNG v base64 a vkládají se jako obrázky, nikdy jako surové značky. Šířka odznaku je jen aproximace, takže velmi neobvyklé fonty nebo nelatinkový text se mohou vykreslit o něco širší než rámeček. GitHub servíruje SVG z repozitáře s restriktivní politikou obsahu, proto při vkládání mimo repozitář použijte raw URL nebo variantu shields.io.