Dříve šlo na Github profilu připnout maximálně 6 repozitářů, takže bylo možné zvýraznit konkrétní práci či projekt. Někdy v druhé polovině roku 2020 ale Github přidal novou možnost, jak si tuto profilovou stránku upravit dle vlastních představ. A to vytvořením profilového Readme.
Repozitář a Readme
Celý proces je velmi jednoduchý. Je potřeba vytvořit veřejný repozitář, jehož název je shodný s Github uživatelským jménem. V tomto repozitáři se pak všechen požadovaný obsah vloží do souboru README.md a ten pak bude automaticky zobrazován na uživatelském profilu.
A to je vše. Nyní už stačí do souboru vložit to, co má vidět každý návštěvník. Pokud by náhodou někdo nevěděl, s čím začít, inspiraci lze hledat v repozitáři coderjojo/creative-profile-readme. Případně na mém osobním Github profilu, rozhodně jsem si s tím ale tak nevyhrál.
Badge a dynamické widgety
Jaké existují generátory pro odznáčky do repozitářů jsem již psal v předchozím článku. Pro více dynamické widgety lze použít třeba Github Readme Stats. V nabídce jsou statistiky commitů, Pull Requstů a další. Nebo taky grafy nejvíce používaných programovacích jazyků.
Nově i pro organizace
Stejná technika lze nyní použít i pro organizace, jen toho nabízí ještě více. Kromě README, který se zobrazí na úvodní stránce organizace, lze také definovat globální Code of Conduct, Contributing guidelines nebo Security rules. Jak to může vypadat je znázorněno přímo v samotné GitHub organizaci github.com/github. Více o této nové funkcionalitě lze najít v dokumentaci.
Generátor
Pouze 3 dny poté, co jsem dopsal tento článek jsem četl blog post od Code OZ, který vytvořitl vlastní nástroj pro generování tohto readme. Lze jej použít na rahuldkjain.github.io/gh-profile-readme-generator.
Máte upravený profil na Githubu? Podělte se s ostatními v komentářích
K tomuto článku již není možné přidávat další komentáře