Генератор на значки (SVG в стил Shields)
Преглед
SVG код
Markdown (shields.io)
Markdown (SVG на собствен хостинг)
Изтеглете SVG файла по-горе, добавете го в хранилището си (например като badge.svg) и го посочете с този относителен път, за да не зависите от shields.io.
HTML
reStructuredText
AsciiDoc
Статичен URL на shields.io
Технически подробности
Как работи генераторът на значки
Какво прави генераторът на значки
Генераторът на значки създава значки за статус в стил shields като самостоятелни SVG файлове. Въведете етикет и съобщение, изберете цветове (имена от shields като brightgreen, hex или rgb стойности) и един от пет стила: flat, flat-square, plastic, for-the-badge или social. Ширините на текста се приближават по метриките на Verdana, така че значката да пасва на съдържанието си, а всичко се визуализира във вашия браузър. Получавате SVG код, изтегляне, съответния URL на shields.io и готови фрагменти за поставяне.
Често срещани случаи на употреба
Значките в README обобщават статуса на билда, покритието, версията, лиценза, поддържаните платформи и спонсорството. Използвайте инструмента, когато искате персонализирана значка, която shields.io не предлага, значка, която трябва да работи офлайн или в частна мрежа, или статичен SVG в хранилището ви, за да не се чупи документацията, когато външна услуга не работи. Предварителните настройки за build passing, MIT лиценз, версия, coverage и PRs welcome дават бърз старт.
Изходни формати
Изходът включва суров SVG, Markdown с URL на изображение от shields.io, Markdown, сочещ към badge.svg на собствен хостинг, HTML img таг, директива image на reStructuredText и макрос image на AsciiDoc. Статичният URL на shields.io следва документираните правила за екраниране: тире става две тирета, долна черта става две долни черти, а интервалите стават долни черти. URL адресът се генерира само като текст и никога не се заявява.
Често срещани клопки и гранични случаи
Цветове, които не са разпознато име, hex стойност или rgb() тройка, се игнорират и се използва стандартният, което предотвратява инжектиране на markup в SVG. Логата трябва да са base64 SVG или PNG data URI и се вграждат като изображения, никога като суров markup. Ширината на значката е приблизителна, така че много необичайни шрифтове или нелатински текст могат да се визуализират малко по-широки от рамката. GitHub сервира SVG от вашето хранилище със строга политика за съдържание, затова използвайте raw URL или варианта на shields.io, когато вграждате извън хранилището.