Preskočiť na obsah
100% lokálne

Generátor odznaků markdown

Vytvoriť odznaky shields.io pre README a zabaliť ich do markdownu, HTML alebo reStructuredTextu.

Hromadné odznaky — jeden popis|hodnota|farba na riadok, na rad odznaků
Výstup

Generátor odznaků markdown

Každé README s indikátorom stavu, číslom verzie alebo ikonou licencie v hornej časti používa odznak shields.io — malý SVG zostavený z popisu, hodnoty a farby. Tento nástroj vám ten odznak vytvára: vyplňte popis, hodnotu a farbu, vyberte štýl a voliteľné logo, a vytvorí URL shields.io a zabali ho do markdownu, ktorý váš projekt skutočne používa.

Všetkých päť štýlov shields.io — flat, flat-square, plastic, for-the-badge a social — je dostupných v možnosti štýlu, a pole loga akceptuje ľubovoľný slug z simple-icons (github, npm, docker a stovky ďalších), farben podľa farby loga, keď chcete, aby zodpovedala odznaku. Pridajte odkaz a odznak sa stane klikateľný v rendovanej stránke; pridajte alternatívny text a zostane zmysluplný pre čítačky obrazovky. Prepínanie formátu výstupu medzi markdownom, HTML a reStructuredTextom znamená, že ten istý odznak padne priamo do README, dokumentačného webu alebo Sphinx projektu bez ručného úpravy markupu.

Vytvorenie viacerých odznaků naraz je to, na čo slúži druhé pole: vložte zoznam, jeden odznak na riadok ako popis|hodnota|farba, a nástroj ho premení na rad odznakou vedľa seba — vzor, ktorý vidíte pod názvom projektu so stavom, pokrytím, verziou a licenciou v jednom rade. Zapnite triedenie na usporiadanie tohto radu abecedne alebo pridajte tabuľku odznakou na rendovanie aj tej istej sady ako dvojstĺpcovej referencie. Možnosť úniku riešiuje jedinú záludnosť shields.io, ktorá ľudí mýli: doslova pomlčka alebo medzera v popise sa musí zdvojiť alebo nahradiť pred tým, ako je URL platný, a tento nástroj to robí automaticky, pokiaľ ho nevypnete.

Všetko sa spúšťa vo vašom prehliadači. Popis, hodnota a akýkoľvek hromadný zoznam, ktorý vložíte, sa používajú iba na lokálne vytvorenie reťazca URL — nič sa nenahrá a nástroj nikdy nekontaktuje samotný shields.io, iba napíše odkaz. Skopírujte výsledok, stiahnite ho ako .txt súbor alebo ho pošlite na vstup iného nástroja, aby ste mohli pokračovať v úprave.

Časté otázky

Čo je odznak shields.io presne?
Je to SVG obrázok generovaný na požiadanie z URL ako https://img.shields.io/badge/label-value-color. Tento nástroj vám vytvorí tú URL a zabali ju do formátu markup, ktorý potrebujete.
Prečo sa môj popis musí uniknúť?
shields.io číta pomlčku ako oddeľovač medzi popisom, hodnotou a farbou. Zapnite "Únik medzier a pomlčiek" a doslova pomlčka alebo medzera v popise sa automaticky zdvojí alebo nahradí, aby URL zostala správne parsovateľná.
Ako funguje režim hromadného spracovania?
Vložte zoznam do druhého poľa, jeden odznak na riadok vo formáte popis|hodnota|farba (farba je voliteľná a padá späť na možnosť Farba). Nástroj ich renduje ako rad odznakou vedľa seba, pripravených na vloženie pod názov projektu.
Môžem namiesto názvu použiť vlastnú šestnástkovú farbu?
Áno. Pole Farba akceptuje buď názov farby shields.io, ako je brightgreen, alebo šestnástkový kód, ako je ff69b4 bez úvodnej #.
Je môj text odznakou niekde nahraný?
Nie. URL odznakou sa zostavuje celý vo vašom prehliadači z polí, ktoré vyplňujete — nič sa nepošle na server a nástroj nikdy nehovorí shields.io sám.