Softonic

README-badgegenerator

Steg 1 / 2 Markeradown
Resultat

Skriv en etikett, ett meddelande och en färg, så bygger den här generatorn en statisk shields.io-badge: den lilla platta kapsel du ser under en README-rubrik (build | passing, license | MIT, version | 1.4.0). Den visar en direktförhandsvisning och ger dig både Markdown och HTML att klistra in. Shields.io är den självklara badge-tjänsten för projekt med öppen källkod; URL-formatet är enkelt men krångligt att memorera, så ett litet grafiskt gränssnitt sparar några minuter när du sätter upp ett nytt repo.

Så skapar du en badge

  1. 1

    Skriv etiketten och meddelandet

    Etiketten är den vänstra halvan (grå); meddelandet är den högra. Skriv det du vill att badgen ska visa: `build` / `passing`, `coverage` / `98%`, `license` / `MIT`.

  2. 2

    Välj en färg

    En namngiven färg (brightgreen, blue, red, orange) eller en hex-kod som `#ff0000`. Den fyller den högra halvan av badgen.

  3. 3

    Ge den stil

    Välj en stil (`flat`, `flat-square`, `for-the-badge`, `plastic`, `social`) och, valfritt, en logotyp via dess simple-icons-slug (github, npm, docker).

  4. 4

    Kopiera Markdown eller HTML

    Klistra in det i din README. Lägg till den valfria länk-URL:en för att göra badgen klickbar. Shields.io renderar SVG:n på begäran.

Vanliga badge-recept

Det här verktyget skapar den statiska formen badge/label-message-color. För badges som visar live-data (byggstatus, version, nedladdningar) kopierar du något av shields.io-URL-mönstren nedan och klistrar in det direkt i din README.

Syfte shields.io-URL-mönster
npm-version https://img.shields.io/npm/v/{package}
npm-nedladdningar https://img.shields.io/npm/dm/{package}
GitHub-stjärnor https://img.shields.io/github/stars/{owner}/{repo}
Senaste commit på GitHub https://img.shields.io/github/last-commit/{owner}/{repo}
GitHub-arbetsflödesstatus https://img.shields.io/github/actions/workflow/status/{owner}/{repo}/{workflow.yml}
Licens https://img.shields.io/github/license/{owner}/{repo}
PyPI-version https://img.shields.io/pypi/v/{package}
Docker-pulls https://img.shields.io/docker/pulls/{org}/{image}
Codecov-täckning https://img.shields.io/codecov/c/github/{owner}/{repo}
Statisk etikett https://img.shields.io/badge/{label}-{message}-{color}

Jämförelse av badge-stilar

  • flat, klassiska rundade rektanglar. Standard.
  • flat-square, skarpa hörn, något modernare.
  • for-the-badge, versaler i blockstil, maximal uppmärksamhet.
  • plastic, gradient och infälld skugga, gammaldags.
  • social, rundade hörn och dämpade färger, matchar GitHubs egna stjärn-/fork-knappar.

När du bör använda badges

  • Bygge + täckning, visar besökarna att projektet faktiskt underhålls.
  • Version + nedladdningar, visar att det används.
  • Licens, en juridisk signal för alla som överväger att bidra eller använda projektet.
  • Dokumentationslänk, extern dokumentationssajt eller rustdoc.rs.
  • Chatt / support, länk till Discord, Matrix eller GitHub Discussions.

När du inte bör använda badges

  • Fåfängestatistik som aldrig uppdateras. En “stjärnor”-badge för ett repo med 0 stjärnor får projektet att se dött ut.
  • Varje tänkbart mått. Fem badges berättar en historia; femton säger ingenting.
  • Dubblerad information. Licens + “MIT” två gånger, eller versionen visad både som badge och i textens första rad.
  • Badges för tjänster du inte använder. Lägg inte till Codecov om du inte har satt upp täckningsrapportering; en trasig badge är sämre än ingen badge alls.

Cachning och tillförlitlighet

Shields.io cachar förfrågningar aggressivt. En badge som uppdateras långsamt behöver oftast bara en cache-rensning (lägg till ?v=2) eller några minuter. Om shields.io ligger nere renderar GitHub texten “shields” utan grafik; värt att nämna, men det återhämtar sig snabbt.

Vanliga frågor

Nej. Shields.io är gratis och finansieras genom donationer. Användare med mycket hög volym uppmanas att köra tjänsten själva eller stödja projektet.

Ja. Shields är öppen källkod och kan köras på din egen domän. De flesta projekt behöver inte det: den kostnadsfria tjänsten är tillförlitlig.

Cachning. Lägg till ?cacheSeconds=60 eller ?v=anything för att tvinga fram en uppdatering. Räkna med upp till några minuter för spridning.

Ja, lägg till ?logo=github (eller vilken simple-icons-slug som helst). Använd ?logoColor=white för att justera ikonens färg.

Nej. Allt körs i webbläsaren och URL:erna genereras på klientsidan för kopiering.

Relaterade verktyg

ASCII-tabellreferens

Full ASCII-tabell från 0 till 127 med decimal-, hex-, oktal- och binärvärden samt notation för numeriska HTML-referenser, inklusive NUL, LF och DEL.

HTML-teckenreferens

En sökbar lista över HTML-entiteter med deras namngivna och numeriska koder samt kopiering med ett klick för specialtecken och symboler.

Referens för kortkommandon

Sök dokumenterade standardkommandon för VS Code, Chrome och Bash med GNU Readline i macOS, Windows och Linux.

E-postvalidator

Validera en e-postadress: RFC 5322-syntaxkontroll, live-slagning av MX-poster samt detaljer om lokal del, domän och längd. Ingen e-post skickas.

EditorConfig-generator

Bygg en .editorconfig utifrån dina regler för indrag, radslut och teckenuppsättning, och lägg till en korrekt sektion för varje språk i repot: Python, Go, YAML, Makefile med flera.

Generator för platshållarbilder

Skapa en bild på 1–4000 px med egna färger och text, ladda ned PNG eller kopiera webbadress och HTML.

Verktyget finns på andra språk