README-Badge-Generator
Erstelle die Status-Badges, die oben in einer GitHub-README stehen: Lizenz, npm-Version, CI-Build, Coverage, Downloads, Sterne oder jede eigene Beschriftung und Farbe. Gib dein Repository einmal ein, sieh dir jeden Stil in der Vorschau an und kopiere fertiges Markdown, HTML oder reStructuredText.
Zuletzt aktualisiert:
Badges
Vorschau
Anleitung: README-Badge-Generator
- Gib dein Projekt ein: GitHub-Owner, Repository, npm-Paketname und CI-Workflow-Datei.
- Füge Badges hinzu über die Buttons, zum Beispiel Lizenz, Build-Status oder ein eigenes Badge.
- Passe jedes Badge an: Label, Farbe, Logo aus Simple Icons und Linkziel.
- Wähle einen Stil und prüfe die Vorschau; hake Echte Badges laden an, um die Live-Werte zu sehen.
- Kopiere den Code in Markdown, HTML oder reStructuredText und füge ihn oben in deine README ein.
Shields.io-URL-Muster
| Badge | URL-Pfad nach https://img.shields.io/ |
|---|---|
| Statisch (Label, Text, Farbe) | badge/build-passing-brightgreen |
| Statisch ohne Label | badge/stable-blue |
| Lizenz von GitHub | github/license/OWNER/REPO |
| npm-Version | npm/v/PACKAGE |
| Monatliche npm-Downloads | npm/dm/PACKAGE |
| GitHub-Actions-Workflow | github/actions/workflow/status/OWNER/REPO/ci.yml?branch=main |
| Codecov-Coverage | codecov/c/github/OWNER/REPO |
| GitHub-Sterne / Issues / letzter Commit | github/stars/OWNER/REPO, github/issues/OWNER/REPO, github/last-commit/OWNER/REPO |
Jedes Badge akzeptiert dieselben Query-Optionen: style, label, color, labelColor, logo und logoColor. Zum Beispiel ?style=for-the-badge&logo=github.
Tipps für eine aufgeräumte Badge-Reihe
- Halte es kurz. Drei bis sechs Badges beantworten die Fragen, die Besucher wirklich haben: Läuft der Build, welche Version ist es, unter welcher Lizenz steht es, wird es gepflegt.
- Setze das wichtigste Badge an den Anfang, meist den Build- oder CI-Status.
- Verwende einen Stil für die ganze Reihe, damit die Höhen übereinstimmen.
- Verlinke jedes Badge mit der Seite, die es erklärt: den Workflow-Läufen, der npm-Seite oder der LICENSE-Datei.
- Schreibe aussagekräftigen Alt-Text wie „build status“, damit Screenreader und nicht geladene Bilder trotzdem verständlich sind.
Du beginnst eine README von Grund auf? Der README-Generator erstellt den Rest der Datei, und der Lizenz-Generator erzeugt die LICENSE, auf die dein Badge verweist.
Häufige Fragen
Wie funktionieren README-Badges?
Ein Badge ist einfach ein Bild. Shields.io erzeugt das SVG auf Anfrage aus der URL: Ein statisches Badge kodiert Label, Text und Farbe im Pfad, und ein dynamisches Badge wie github/license/owner/repo ruft bei jedem Aufruf der README den aktuellen Wert von GitHub, npm oder einem anderen Dienst ab.
Wie schreibe ich einen Bindestrich, Unterstrich oder ein Leerzeichen in ein statisches Badge?
In der URL eines statischen Shields.io-Badges trennen Bindestriche Label, Text und Farbe, daher wird ein echter Bindestrich als zwei Bindestriche (--) geschrieben. Ein Unterstrich oder %20 steht für ein Leerzeichen, daher wird ein echter Unterstrich als zwei Unterstriche (__) geschrieben. Dieser Generator wendet diese Regeln für dich an.
Welche Logos kann ich verwenden?
Shields.io akzeptiert die Namen von Simple Icons, etwa github, npm, python, docker, javascript oder githubactions. Gib den Namen kleingeschrieben und ohne Leerzeichen ein. logoColor ändert die Farbe des Icons; die Offline-Vorschau zeigt einen Platzhalter, wo das Icon erscheinen wird.
Warum zeigt mein Badge "repo not found" oder "invalid"?
Dynamische Badges lesen Live-Daten, daher muss das Repository, Paket oder der Workflow existieren und öffentlich sein. Prüfe die Schreibweise von Owner, Repository und Paket und bei Build-Badges den genauen Dateinamen des Workflows in .github/workflows, etwa ci.yml.
Welche Farben kann ich verwenden?
Benannte Farben (brightgreen, green, yellowgreen, yellow, orange, red, blue, lightgrey, grey, blueviolet), die semantischen Namen success, important, critical, informational und inactive oder jeden Hex-Code wie ff69b4. Lass die Farbe eines dynamischen Badges leer, um die von Shields.io für den Wert gewählte Farbe zu verwenden.
Welchen Badge-Stil sollte ich wählen?
flat ist der häufigste Standard. flat-square hat eckige Ecken, for-the-badge ist größer mit Großbuchstaben und passt zu Projekt-Landingpages, plastic ist der ältere glänzende Look, und social ahmt die Stern- und Folgen-Buttons von GitHub nach. Verwende für alle Badges einer Reihe denselben Stil.
Wird etwas hochgeladen?
Nein. Der Badge-Code wird in deinem Browser erstellt, und die Standardvorschau wird lokal gezeichnet. Nur wenn du Echte Badges laden anhakst, fordert dein Browser die Badge-Bilder von img.shields.io an – genau wie GitHub es tut, wenn es deine README anzeigt.
Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?
Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.