README-Badge-Markdown mit Alternativtext erstellen

Der Generator gibt das vollständige Markdown, die zugrunde liegende Bild-URL und den lesbaren Alternativtext als getrennte Felder zurück. Leerzeichen, Bindestriche, Unterstriche, Satzzeichen und für Markdown relevante eckige Klammern werden sicher verarbeitet. Dadurch bleibt die Struktur auch dann korrekt, wenn Beschriftungen echte Build-Aufträge oder Veröffentlichungskanäle bezeichnen. Nutzen Sie das Browserwerkzeug für ein einzelnes Badge oder rufen Sie die deterministische API auf, wenn Ihre Dokumentation automatisch zusammengestellt wird.

Wählen Sie einen kurzen Text, der den Status vermittelt

Ein nützliches Badge beantwortet auf einen Blick eine kleine, konkrete Frage. Setzen Sie links die Kategorie als Beschriftung und rechts ihren aktuellen Wert als Meldung ein. Eine Beschriftung wie Build zusammen mit einer Meldung wie erfolgreich lässt sich beispielsweise schneller erfassen als ein langer Satz, der in ein Bild gedrängt wurde. Der erzeugte Alternativtext verbindet beide Werte mit einem Doppelpunkt. Menschen mit Screenreader erhalten dadurch dieselbe grundlegende Beziehung, die visuell vermittelt wird. Beide Werte sollten auch ohne Farbe verständlich sein, denn Farbe darf niemals allein einen wesentlichen Status ausdrücken. Der Generator entfernt äußere Leerzeichen, bewahrt aber die beabsichtigte Schreibweise und Großschreibung. Leere Beschriftungen und Meldungen werden abgewiesen, statt ein verwirrendes Bild mit einer leeren Hälfte zu erzeugen. Wenn das Badge eine Automatisierung darstellt, verwenden Sie über Veröffentlichungen hinweg eine stabile Wortwahl, damit Änderungen lesbar bleiben. Über das Feld alt_text kann Ihre Dokumentationskette die barrierefreie Beschreibung außerdem unabhängig vom fertigen Markdown prüfen oder wiederverwenden.

Verstehen Sie den Aufbau der Shields-Bild-URL

Statische Shields-Badges codieren Beschriftung, Meldung und Farbe im Pfad eines Bildes. Für diesen Pfad gelten besondere Trennregeln: Leerzeichen werden zu Unterstrichen, wörtliche Unterstriche werden verdoppelt und wörtliche Bindestriche ebenfalls, damit sie nicht mit den Trennzeichen zwischen Badge-Teilen verwechselt werden. Andere Satzzeichen werden für eine gültige URL prozentcodiert. Diese Fähigkeit wendet die Umformungen deterministisch an und gibt die entstandene URL zusammen mit dem Markdown zurück. Eine hexadezimale Farbe darf mit einer führenden Raute angegeben werden; diese wird entfernt, bevor die Farbe in den Pfad gelangt. Shields-Farbnamen wie brightgreen können Sie direkt verwenden. Der Dienst nimmt keinen Kontakt zu Shields auf und prüft nicht, wie ein bestimmter Farbname dargestellt wird. Er erzeugt lediglich den üblichen Bildverweis. Dadurch bleibt die Ausführung schnell, privat und für Offline-Dokumentationsläufe geeignet. Ein erfolgreicher Aufruf bestätigt also die erzeugte Syntax und nicht den Abruf des entfernten Bildes. Sie können das Ergebnis in einer Vorlage speichern und das Bild später vom README-Betrachter laden lassen.

Fügen Sie das Markdown sicher ein und automatisieren Sie es

Kopieren Sie das Feld markdown in ein README, eine Pull-Request-Vorlage, eine Paketseite oder ein anderes Markdown-Dokument, das entfernte Bilder zulässt. Das Ergebnis nutzt die vertraute Bildform mit barrierefreiem Text in eckigen Klammern und der Shields-URL in runden Klammern. Eckige Klammern und umgekehrte Schrägstriche im sichtbaren Text werden maskiert, damit vom Benutzer gelieferte Formulierungen den Alternativtext nicht vorzeitig beenden. Senden Sie in einem automatisierten Ablauf beim Rendern der Dokumentation die drei Eingabefelder und schreiben Sie den zurückgegebenen markdown-Wert an die vorgesehene Stelle. Der Algorithmus hängt weder von Uhrzeit, Zufall, Zustand noch Netzwerk ab. Gleiche Eingaben liefern deshalb stets gleiche Ausgaben, wodurch erzeugte Dateien in der Versionsverwaltung stabil bleiben. Verwalten Sie Platzierung und Reihenfolge der Badges in Ihrer eigenen Vorlage, statt hier ein vollständiges README zusammenzusetzen. Diese Fähigkeit erzeugt bewusst genau ein Badge pro Anfrage. Sie bearbeitet keine Repositorys, prüft keine Build-Ergebnisse und bestimmt keinen Status. Ihre vorgeschaltete Automatisierung liefert die Wahrheit; dieser Generator übernimmt korrekte Codierung und Darstellung.