Badge-generator (SVG in Shields-stijl)
Voorbeeld
SVG-code
Markdown (shields.io)
Markdown (zelf gehoste SVG)
Download de SVG hierboven, commit hem in je repository (bijvoorbeeld als badge.svg) en verwijs ernaar met dit relatieve pad om niet van shields.io afhankelijk te zijn.
HTML
reStructuredText
AsciiDoc
Statische shields.io-URL
Technische details
Hoe de badge-generator werkt
Wat de badge-generator doet
De badge-generator bouwt statusbadges in shields-stijl als losse SVG-bestanden. Voer een label en een bericht in, kies kleuren (shields-namen zoals brightgreen, hex- of rgb-waarden) en een van de vijf stijlen: flat, flat-square, plastic, for-the-badge of social. Tekstbreedtes worden benaderd met Verdana-metrieken zodat de badge bij de inhoud past, en alles wordt in je browser gerenderd. Je krijgt de SVG-code, een download, de gelijkwaardige shields.io-URL en kant-en-klare snippets.
Veelvoorkomende toepassingen
README-badges geven een overzicht van buildstatus, dekking, versie, licentie, ondersteunde platforms en sponsoring. Gebruik deze tool als je een eigen badge wilt die shields.io niet biedt, als de badge offline of in een privénetwerk moet werken, of als je een statische SVG in de repository commit zodat documentatie nooit breekt doordat een externe dienst offline is. De voorinstellingen build passing, MIT license, version, coverage en PRs welcome geven je een snelle start.
Uitvoerformaten
De uitvoer bevat ruwe SVG, Markdown met een shields.io-afbeeldings-URL, Markdown die naar een zelf gehoste badge.svg verwijst, een HTML img-tag, een reStructuredText image-directive en een AsciiDoc image-macro. De statische shields.io-URL volgt de gedocumenteerde escape-regels: een streepje wordt twee streepjes, een underscore wordt twee underscores en spaties worden underscores. De URL wordt alleen als tekst gegenereerd en nooit opgevraagd.
Veelvoorkomende valkuilen en randgevallen
Kleuren die geen herkende naam, hexwaarde of rgb()-drietal zijn, worden genegeerd en de standaardkleur wordt gebruikt, wat voorkomt dat markup in de SVG wordt geïnjecteerd. Logo's moeten base64 SVG- of PNG-data-URI's zijn en worden als afbeeldingen ingebed, nooit als ruwe markup. De badgebreedte is een benadering, dus zeer ongebruikelijke lettertypen of niet-Latijnse tekst kunnen iets breder worden weergegeven dan het vak. GitHub serveert SVG's uit je repository met een strikt contentbeleid, gebruik dus de raw-URL of de shields.io-variant bij insluiten buiten de repository.