GitHub Profile README

GitHub a un easter egg documenté : un repo dont le nom correspond exactement à votre nom d'utilisateur affiche son README.md en haut de votre profil public.

Créer le repo

Aller sur github.com/new et nommer le repo exactement comme votre username.

Nom du repo : williamloree

GitHub affiche un message vert : "williamloree/williamloree is a special repository." C'est le signal que le mécanisme est activé.

Cocher "Add a README file" à la création — ça évite un repo vide.

Le repo doit être Public. Un repo privé n'affiche rien sur le profil.

Structure minimale

Le seul fichier obligatoire est README.md à la racine. Tout le reste est optionnel.

williamloree/
└── README.md   ← seul fichier requis

Des dossiers .github/workflows/ peuvent s'ajouter pour l'automatisation (chapitre 7), mais pour l'instant une seule ligne suffit à activer l'affichage :

# Bonjour, je suis William 👋

Ce que voit le visiteur

Le README.md s'affiche directement sur github.com/williamloree, rendu en HTML par GitHub. Toutes les fonctionnalités Markdown de GitHub sont disponibles : images, liens, tableaux, HTML inline, et même certains éléments SVG.

Ce que GitHub n'autorise pas pour des raisons de sécurité :

• JavaScript (les balises <script> sont ignorées)
• CSS externe ou styles <style> (sauf attributs style="" inline)
• iframes
• Formulaires

Tout le design passe donc par du Markdown enrichi et du HTML inline limité.

Cloner et éditer localement

git clone https://github.com/votre-username/votre-username.git
cd votre-username

Éditer README.md dans VSCode, commiter, pusher. GitHub re-rend le Markdown instantanément.

git add README.md
git commit -m "init profile readme"
git push

Le profil se met à jour en quelques secondes après le push.