Générez le Markdown d’un badge README avec texte alternatif

Le générateur renvoie séparément le Markdown complet, l’URL de l’image et un texte alternatif lisible. Il traite correctement les espaces, traits d’union, tirets bas, signes de ponctuation et crochets sensibles à Markdown, afin de préserver une structure valide lorsque vos libellés décrivent de véritables tâches de compilation ou canaux de publication. Utilisez l’outil dans votre navigateur pour un badge ponctuel ou appelez l’API déterministe lorsque votre documentation est assemblée automatiquement.

Choisissez un texte bref qui communique clairement l’état

Un badge utile répond d’un coup d’œil à une question précise. Placez la catégorie à gauche comme libellé, puis sa valeur actuelle à droite comme message. Par exemple, un libellé tel que compilation associé à un message tel que réussie se lit mieux qu’une longue phrase comprimée dans une image. Le texte alternatif produit relie les deux valeurs par deux-points : les personnes utilisant un lecteur d’écran reçoivent ainsi la même relation élémentaire que celle exprimée visuellement. Veillez à ce que les deux valeurs gardent leur sens sans la couleur, car celle-ci ne doit jamais être le seul vecteur d’un état essentiel. Le générateur supprime les espaces extérieurs, mais conserve les mots et la casse choisis. Les libellés et messages vides sont refusés afin d’éviter une image ambiguë dont une moitié serait blanche. Pour un badge automatisé, adoptez un vocabulaire stable entre les versions afin que les différences restent lisibles. Le champ alt_text permet aussi à votre chaîne documentaire de contrôler ou réutiliser la description accessible indépendamment du Markdown final.

Comprenez la construction de l’URL d’image Shields

Les badges statiques Shields encodent le libellé, le message et la couleur dans le chemin d’une image. Ce chemin applique des règles particulières : les espaces deviennent des tirets bas, les tirets bas littéraux sont doublés et les traits d’union littéraux le sont également, afin de ne pas les confondre avec les séparateurs entre les parties. Les autres signes sont encodés en pourcentage pour former une URL valide. Cette capacité applique ces transformations de manière déterministe et renvoie l’URL obtenue avec le Markdown. Vous pouvez fournir une couleur hexadécimale précédée d’un dièse ; celui-ci est retiré avant l’insertion dans le chemin. Les noms Shields tels que brightgreen sont acceptés directement. Le service ne contacte pas Shields et ne vérifie pas le rendu d’un nom de couleur. Il produit seulement la référence d’image conventionnelle, ce qui garantit une exécution rapide, privée et adaptée aux compilations documentaires hors ligne. Un résultat réussi atteste donc la syntaxe produite, et non le téléchargement de l’image distante. Vous pouvez enregistrer la sortie dans un modèle et laisser le lecteur final du README charger l’image normalement.

Insérez et automatisez le Markdown en toute sécurité

Copiez le champ markdown dans un README, un modèle de demande de fusion, une page de paquet ou tout document Markdown autorisant les images distantes. Le résultat adopte la syntaxe d’image habituelle, avec le texte accessible entre crochets et l’URL Shields entre parenthèses. Les crochets et barres obliques inverses du texte visible sont échappés afin qu’un contenu fourni par l’utilisateur ne ferme pas prématurément la zone de texte alternatif. Dans un flux automatisé, envoyez les trois champs d’entrée lors du rendu de la documentation, puis écrivez la valeur markdown renvoyée à l’emplacement prévu. Comme l’algorithme ne dépend ni de l’heure, ni du hasard, ni d’un état, ni du réseau, des entrées identiques donnent toujours une sortie identique ; les fichiers générés restent donc stables dans le contrôle de versions. Gérez la position et l’ordre des badges dans votre propre modèle plutôt que de composer ici un README entier. Cette capacité crée volontairement un seul badge par requête : elle ne modifie aucun dépôt, ne consulte aucun résultat de compilation et ne décide pas du statut à afficher. Votre automatisation fournit l’information ; le générateur assure son encodage et sa présentation.