Aller au contenu principal
Badges README

Générateur de badges

Composez un badge « libellé | message » pour un README ou un site, voyez-le sur fond clair et sombre, et copiez le code à coller.

Votre badge

files: processed locally
Code à coller
![files: processed locally](https://awesometoolkit.com/api/badge?label=files&message=processed+locally&color=44cc11&labelColor=555555)

Contenu

Tout prêts

Apparence

Couleur du message
Couleur du libellé

Lien

Un clic ouvre ce générateur avec votre badge déjà rempli — pour que d'autres puissent en faire un pareil. Choisissez « Mon lien » pour envoyer les lecteurs ailleurs.

En savoir plus

Les badges de README : l'essentiel

À quoi servent les badges de README

Les badges sont de petites pastilles « libellé | message » en haut d'un README. Ils résument un projet (licence, état du build, version, façon de contribuer) dans un format que tous les développeurs reconnaissent, sur GitHub, GitLab ou un registre de paquets.

Markdown ou HTML ?

Le Markdown est ce que lisent les README sur GitHub, GitLab et la plupart des registres de paquets. Utilisez le HTML sur un site, ou dans un README pour régler la taille ou aligner les badges sur une ligne.

Comment ça marche

Créer un badge en 3 étapes

  1. Écrivez-le

    Partez d'un badge tout prêt ou tapez un libellé et un message.

  2. Colorez-le

    Choisissez les couleurs et le style ; l'aperçu le montre sur une page claire et une page sombre, comme les deux thèmes de GitHub.

  3. Collez-le

    Copiez le Markdown pour un README ou le HTML pour un site, ou téléchargez le SVG.

Guides pratiques

Un README clair d'un coup d'œil

Des badges utiles

Quelques badges en haut d'un README répondent d'un coup d'œil aux premières questions : licence, état du projet, contributions bienvenues ou non.

Restez court et sobre (trois à cinq badges) et reliez chacun à l'endroit où se trouve la réponse : le fichier de licence, la documentation.

Astuce

Confidentialité

Ni compte ni pistage : l'image du badge est générée à partir de son adresse à chaque affichage.

Vous préférez ne dépendre de rien ? Téléchargez le SVG et hébergez-le avec votre projet.

Sans pistage
Questions fréquentes

Badges README — questions fréquentes

GitHub, liens, cache, hébergement : tout pour créer vos badges