Générateur de README de profil GitHub

Résultats

Créer un dépôt dont le nom correspond à votre nom d’utilisateur GitHub vous donne un README qui apparaît en haut de votre page de profil. Ce générateur produit un fichier Markdown propre pour ce dépôt : titre, courte biographie, stack technologique et cartes de statistiques optionnelles alimentées par github-readme-stats.

Comment construire le README de profil

  1. 1

    Remplissez vos détails

    Nom d'affichage, slogan, emplacement, sur quoi vous travaillez et ce que vous apprenez.

  2. 2

    Ajoutez votre stack technologique

    Liste séparée par des virgules ; chaque élément est affiché sous forme de badge en gras.

  3. 3

    Activez les cartes de statistiques

    Les cartes GitHub Stats et Top Languages se rendent en direct depuis github-readme-stats ; l'option d'activité ajoute un lien vers votre graphique de contributions.

  4. 4

    Copiez le Markdown

    Créez un dépôt nommé d'après votre nom d'utilisateur et poussez le README.md à la racine.

Comment fonctionne le “dépôt spécial”

Si votre nom d’utilisateur est alex et que vous créez un dépôt public nommé alex, GitHub rend le README.md de ce dépôt sur votre profil (au-dessus des dépôts populaires). C’est une fonctionnalité documentée, pas un hack.

Cartes que le générateur peut intégrer

Carte URL source Remarques
Statistiques GitHub github-readme-stats-one-bice.vercel.app/api?username=...&show_icons=true Commits, PRs, problèmes
Langages principaux github-readme-stats-one-bice.vercel.app/api/top-langs/?username=... Répartition des langages par taille de dépôt
Activité de contributions github.com/{username}?tab=overview Lien affiché lorsque « Streak » est activé

Les deux cartes de statistiques sont des points de terminaison PNG, elles se rendent sur n’importe quel visualiseur Markdown, y compris lorsque quelqu’un charge votre profil sans être authentifié ; le lien d’activité ouvre votre graphique de contributions sur GitHub.

Contenu qui se lit bien

  • Slogan en une ligne : rôle + focus (“Ingénieur infra Rust, intéressé par le traçage”).
  • 3–5 points max au-dessus de la stack ; plus et cela ressemble à un CV.
  • Compétences sous forme de badges, pas un paragraphe. Les lecteurs cherchent les technologies du regard.
  • Liens vers des projets que vous maintenez réellement. Les dépôts abandonnés épinglés sur le profil sont pires que rien.
  • Ligne de contact : email ou un seul réseau social ; évitez de lister six réseaux.

Ce qu’il ne faut pas y mettre

  • Adresses privées ou numéros de téléphone.
  • Texte pour recruteurs (“Ouvert au travail” appartient à LinkedIn ou à l’option bannière GitHub).
  • Émojis sur chaque ligne, un ou deux sont acceptables, une jungle est du bruit.

Questions fréquentes

github-readme-stats est hébergé sur Vercel et limite parfois le taux ou met en cache des données obsolètes. Si une carte ne fonctionne pas, attendez quelques minutes ou auto-hébergez le projet, le dépôt a un bouton de déploiement Vercel en un clic.

Seulement si vous authentifiez le service avec un jeton ayant le champ repo. Par défaut, les statistiques ne comptent que les commits publics, ce qui est généralement le bon choix sur un profil public.

Oui. GitHub autorise un sous-ensemble de HTML dans Markdown, <img>, <details>, <sub>, <sup> et des styles en ligne simples. Les scripts et les formulaires sont supprimés pour des raisons de sécurité.

Non. Les valeurs que vous saisissez sont envoyées à notre serveur pour générer l’aperçu et, dans la vue en plusieurs étapes, elles sont transportées dans le lien de la page entre les étapes. Rien n’est stocké dans une base de données et tout est supprimé à la fermeture de l’onglet.

Outils similaires

Outil disponible dans d’autres langues