05/05/2021 Créer un readme sur son profil github

Modifier sa page readme sur son profil github. Pour afficher un message de bienvenue, son CV, ou tout ce qui vous passe par la tête.

Comment ça marche ?

Depuis, l'été 2020 Github permet à celle et ceux qui le souhaitent, d'agrémenter leur page public avec un readme. Pour cela il suffit de créer un repo du même nom que votre pseudo sur github.
Par exemple, mon pseudo Github est Auncly, j'ai donc créé un repo Auncly/Auncly .
Si vous ne vous êtes pas trompé Github devrait vous afficher un petit message comme celui-ci.

Message special

Ensuite, il vous suffit de rédiger votre texte, vous pouvez y mettre des liens, images, etc. C'est vous qui choisissez. Vous devez simplement respecter la nomenclature markdown. Comme ceci :
Par exemple voici début de mon readme.md en syntaxe markdown.

1![Pyrenees](https://images.unsplash.com/photo-1554097092-bc5ad8df0f2d?ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&ixlib=rb-1.2.1&auto=format&fit=crop&w=1953&q=80)
2## En bref
3 
4Hello,
5...

Vous pouvez aussi insérer des balises HTML qui sont aussi supportés.
J'utilise PhpStorm comme éditeur de code pour mon travail et markdown est très bien supporté par cet IDE puisqu'il vous affiche une pré-visualisation en direct comme vous pouvez le voir :

Previsualisation en direct de PhpStorm

Rien de compliqué ! Moi, j'ai fait simple pour mon readme, j'ai rédigé mon CV sur ma page, mais je sais que grâce aux github actions il est possible de faire des choses beaucoup plus poussées, comme intégrer la liste de ses derniers articles publiés sur medium, ses dernières issues ou PR soumises, ou la liste des derniers repos dans lequel vous avez commit etc ... Si vous voulez vous faire une idée de ce que ça donne, voici le repo de mon readme ici, qui met permet d'afficher sur mon profil public le contenu de mon readme.

Je vous mets ici le lien vers la documentation officielle de github concernant cette feature.

Je vous dit à la prochaine !

Made with and by Auncly.