Přeskočit na obsah
100% lokálně

Generátor odznaků markdown

Vytvořit odznaky shields.io pro README a zabalit je do markdownu, HTML nebo reStructuredTextu.

Hromadné odznaky — jeden popis|hodnota|barva na řádek, na řadu odznaků
Výstup

Generátor odznaků markdown

Každé README se stavovým indikátorem, číslem verze nebo ikonou licence v horní části používá odznak shields.io — malý SVG složený z popisu, hodnoty a barvy. Tento nástroj vám ten odznak vytvoří: vyplňte popis, hodnotu a barvu, vyberte styl a volitelné logo, a vytvoří URL shields.io a zabalí ho do markdownu, který váš projekt skutečně používá.

Všech pět stylů shields.io — flat, flat-square, plastic, for-the-badge a social — je dostupných v možnosti stylu, a pole loga přijímá jakýkoli slug z simple-icons (github, npm, docker a stovky dalších), zbarvený barvou loga, když chcete, aby odpovídal odznaku. Přidejte odkaz a odznak se stane klikatelný na vykreslené stránce; přidejte alternativní text a zůstane smysluplný pro čtečky obrazovky. Přepínání formátu výstupu mezi markdownem, HTML a reStructuredTextem znamená, že stejný odznak jde přímo do README, webu dokumentace nebo projektu Sphinx bez ručních úprav značek.

Vytvoření více odznaků najednou je to, na co slouží druhé pole: vložte seznam, jeden odznak na řádek jako popis|hodnota|barva, a nástroj jej změní na řadu odznaků vedle sebe — vzor, který vidíte pod názvem projektu se stavem, pokrytím, verzí a licencí v jednom řádku. Zapněte řazení na uspořádání tohoto řádku abecedně, nebo přidejte tabulku odznaků a také vykreslete stejnou sadu jako dvoustupňový odkaz. Možnost escape řeší jednu záludnost shields.io, která lidi mate: doslova pomlčka nebo mezera v popisu se musí zdvojit nebo nahradit, než je URL platné, a tento nástroj to dělá automaticky, pokud jej nevypnete.

Všechno běží ve vašem prohlížeči. Popis, hodnota a jakýkoli hromadný seznam, který vložíte, se používají pouze k lokálnímu vytvoření řetězce URL — nic se nenahraje a nástroj nikdy nezkontaktuje samotný shields.io, stačí napsat odkaz. Zkopírujte výsledek, stáhněte jej jako soubor .txt nebo jej pošlete na vstup jiného nástroje, abyste pokračovali v úpravách.

Časté dotazy

Co je přesně odznak shields.io?
Je to SVG obraz generovaný na vyžádání z adresy URL jako https://img.shields.io/badge/label-value-color. Tento nástroj pro vás vytvoří tuto adresu URL a zabalí ji do formátu značky, který potřebujete.
Proč se musí můj popis vyhnout?
shields.io čte pomlčku jako oddělovač mezi popisem, hodnotou a barvou. Zapněte "Úniko mezer a pomlček" a doslova pomlčka nebo mezera v popisu se automaticky zdvojí nebo nahradí tak, aby byla adresa URL správně parsovatelná.
Jak funguje režim hromadného zpracování?
Vložte seznam do druhého pole, jeden odznak na řádek ve formátu popis|hodnota|barva (barva je volitelná a padá zpět na možnost Barva). Nástroj je vykreslí jako řadu odznaků vedle sebe, připravených na vložení pod název projektu.
Mohu místo jména použít vlastní šestnáctkový kód barvy?
Ano. Pole Barva přijímá buď název barvy shields.io, jako je brightgreen, nebo šestnáctkový kód, jako je ff69b4 bez úvodního #.
Je můj text odznaku niekde nahrán?
Ne. Adresa URL odznaku se skládá zcela ve vašem prohlížeči z polí, která vyplňujete — nic se neodesílá na server a nástroj nikdy nehovoří se samotným shields.io.