Badge-generator (SVG i Shields-stil)
Forhåndsvisning
SVG-kode
Markdown (shields.io)
Markdown (selvhostet SVG)
Download SVG'en ovenfor, commit den til dit repository (for eksempel som badge.svg), og henvis til den med denne relative sti, så du ikke er afhængig af shields.io.
HTML
reStructuredText
AsciiDoc
Statisk shields.io-URL
Tekniske detaljer
Sådan fungerer badge-generatoren
Hvad badge-generatoren gør
Badge-generatoren bygger statusbadges i shields-stil som selvstændige SVG-filer. Indtast en etiket og en besked, vælg farver (shields-navne som brightgreen, hex- eller rgb-værdier) og en af fem stilarter: flat, flat-square, plastic, for-the-badge eller social. Tekstbredder tilnærmes ud fra Verdana-metrikker, så badget passer til indholdet, og alt gengives i din browser. Du får SVG-koden, en download, den tilsvarende shields.io-URL og klar-til-indsættelse-uddrag.
Almindelige anvendelser
README-badges opsummerer build-status, dækning, version, licens, understøttede platforme og sponsorering. Brug værktøjet, når du vil have et eget badge, som shields.io ikke tilbyder, et badge, der skal virke offline eller i et privat netværk, eller en statisk SVG i dit repository, så dokumentationen aldrig går i stykker, når en tredjepartstjeneste er nede. Forudindstillinger for build passing, MIT-licens, version, coverage og PRs welcome giver dig en hurtig start.
Outputformater
Outputtet omfatter rå SVG, Markdown med en shields.io-billed-URL, Markdown der peger på en selvhostet badge.svg, et HTML img-tag, et reStructuredText image-direktiv og en AsciiDoc image-makro. Den statiske shields.io-URL følger de dokumenterede escape-regler: en bindestreg bliver til to bindestreger, en understregning bliver til to understregninger, og mellemrum bliver til understregninger. URL'en genereres kun som tekst og kaldes aldrig.
Almindelige faldgruber og grænsetilfælde
Farver, der ikke er et genkendt navn, en hex-værdi eller en rgb()-tripel, ignoreres, og standardfarven bruges, hvilket forhindrer indsprøjtning af markup i SVG'en. Logoer skal være base64 SVG- eller PNG-data-URI'er og indlejres som billeder, aldrig som rå markup. Badgets bredde er en tilnærmelse, så meget usædvanlige skrifttyper eller ikke-latinsk tekst kan blive gengivet lidt bredere end feltet. GitHub leverer SVG'er fra dit repository med en restriktiv indholdspolitik, så brug rå-URL'en eller shields.io-varianten, når du indlejrer uden for repositoryet.