Markdown jelvény generátor
shields.io jelvények README-hez, Markdown, HTML vagy reStructuredText formátumban
Markdown jelvény generátor
Minden README, amely felül build státuszt, verziószámot vagy licencikont tartalmaz, shields.io jelvényt használ — egy kicsi SVG, amely egy címkéből, egy értékből és egy színből áll. Ez az eszköz azt a jelvényt készíti el: írja be a címkét, az értéket és a színt, válassza ki a stílust és egy opcionális logót, és az eszköz összeállítja a shields.io URL-t, és azt az adott projektben használt formátumba csomagolja.
A style opció mind az öt shields.io renderelést tartalmazza — flat, flat-square, plastic, for-the-badge és social — és a logo mező bármilyen simple-icons slug-ot fogad (github, npm, docker és több száz másik), logó színnel tintázva, ha szeretné, hogy a jelvényhez illessen. Adjon hozzá egy linket, és a jelvény kattintható lesz a renderelt oldalon; adjon hozzá alt szöveget, és a képernyőolvasók számára is érthető marad. A kimeneti formátum Markdown, HTML és reStructuredText közötti váltással lejátszódik, így ugyanaz a jelvény egyenesen egy README-be, egy dokumentációs webhelyre vagy egy Sphinx projektbe esik, anélkül, hogy a kódot kézzel kellene módosítani.
Egynél több jelvény készítése egyszerre az, amire a második doboz szolgál: illessze be az listát, soronként egy jelvényt: címke|érték|szín formátumban, és az eszköz egy sor jelvényt készít egymás mellett — a mintát, amelyet a projekt címe alatt láthat a build, a lefedettség, a verzió és a licenc egy sorban. Kapcsolja be a rendezést ahhoz, hogy ezt a sort ábécé sorrendjében rendezze, vagy adjon hozzá egy jelvénytáblát ugyanez halmazhoz kétoszlopos referenciaként való rendereléshez. Az escape opció az egyik shields.io furcsaságot kezelni: egy szó szerinti gondolatjel vagy szóköz a címkében meg kell kettőzve vagy cserélve lenne az URL érvényes legyen, és ez az eszköz automatikusan megteszi, hacsak nem kapcsolja ki.
Minden a böngészőben fut. A címke, érték és bármilyen tömeges lista, amely beilleszti, csak egy URL-karakterlánc készítéséhez használatos helyileg — semmi sem töltődik fel, és az eszköz sosem kerül kapcsolatba a shields.io-val, csak az linket írja. Másolja ki az eredményt, töltse le .txt fájlként, vagy küldje el egy másik eszközbe a szerkesztés folytatásához.