Jelvénygenerátor (Shields stílusú SVG)
Előnézet
SVG-kód
Markdown (shields.io)
Markdown (saját tárhelyű SVG)
Töltse le a fenti SVG-t, adja hozzá a tárolójához (például badge.svg néven), és erre a relatív útvonalra hivatkozzon, hogy ne függjön a shields.io-tól.
HTML
reStructuredText
AsciiDoc
shields.io statikus URL
Technikai részletek
Hogyan működik a jelvénygenerátor
Mit csinál a jelvénygenerátor
A jelvénygenerátor Shields stílusú állapotjelvényeket készít önálló SVG-fájlként. Adjon meg címkét és üzenetet, válasszon színeket (Shields-nevek, például brightgreen, hex vagy rgb értékek) és az öt stílus egyikét: flat, flat-square, plastic, for-the-badge vagy social. A szövegszélességet a Verdana metrikái alapján becsüli, így a jelvény illeszkedik a tartalmához, és minden a böngészőben jelenik meg. Megkapja az SVG-kódot, a letöltést, az ennek megfelelő shields.io URL-t és a beilleszthető kódrészleteket.
Gyakori felhasználási esetek
A README-jelvények összefoglalják a build állapotát, a lefedettséget, a verziót, a licencet, a támogatott platformokat és a szponzorálást. Akkor használja az eszközt, ha olyan egyedi jelvényre van szüksége, amelyet a shields.io nem kínál, ha a jelvénynek offline vagy privát hálózaton is működnie kell, vagy ha a tárolóba commitolt statikus SVG-t szeretne, hogy a dokumentáció ne romoljon el, amikor egy külső szolgáltatás nem elérhető. A build passing, MIT licenc, verzió, lefedettség és PRs welcome előbeállítások gyors kezdést adnak.
Kimeneti formátumok
A kimenet tartalmaz nyers SVG-t, Markdownt shields.io képes URL-lel, Markdownt saját tárhelyű badge.svg-re mutatva, HTML img címkét, reStructuredText image direktívát és AsciiDoc image makrót. A shields.io statikus URL a dokumentált escape-szabályokat követi: egy kötőjel két kötőjel lesz, egy aláhúzás két aláhúzás lesz, a szóközök pedig aláhúzássá válnak. Az URL csak szövegként jön létre, és soha nem kérdezi le a rendszer.
Gyakori buktatók és szélsőséges esetek
Az olyan színeket, amelyek nem felismert nevek, hex értékek vagy rgb() hármasok, a rendszer figyelmen kívül hagyja, és az alapértelmezettet használja, ami megakadályozza a markup SVG-be injektálását. A logóknak base64 SVG vagy PNG data URI-nak kell lenniük, és képként ágyazódnak be, soha nem nyers markupként. A jelvény szélessége becslés, ezért a nagyon szokatlan betűtípusok vagy a nem latin szöveg kissé szélesebb lehet a keretnél. A GitHub szigorú tartalmi szabályzattal szolgálja ki a tárolóból az SVG-ket, ezért a tárolón kívüli beágyazáshoz használja a raw URL-t vagy a shields.io változatot.