Github Pages - stránky pro tebe i tvůj projekt

Github nabízí možnost vytvářet jednoduché stránky pro uživatele či projekt zdarma přímo na adrese github.io. Sice nelze používat skriptovací jazyky jako PHP, Python a další. Přesto každý repozitář může mít své stránky až o velikosti 1 GB, měsíčním přenosu dat do 100 GB a do 10 updatů za hodinu. Ukázka je na adrese arxeiss.github.io/resampler.php/ pro mou knihovnu Resampler.

Stránky jako součást repozitáře

Asi je jasné, že znalost gitu je potřeba, protože vše se nečekaně nahrává na git server. Stačí ale projet git tutoriál, protože nic složitého to opravdu není. 

Stránky lze vytvořit od základu ručně, nebo pomocí předpřipraveného schématu. V prvním případě se vytváří jednoduchá HTML šablona včetně obrázků, CSS a JS. V případě druhém se web tvoří pomocí markdown souborů a nástroje Jekyll, o tom ale více v nápovědě.

Uložení ve větvi nebo složce docs

Github nabízí 3 možnosti, jak stránky v repozitáři ukládat. Lze je vložit přímo do master větve, do větve gh-pages, nebo do složky docs v master větvi. Ve větvi gh-pages nemají být obsaženy žádné soubory z projektu. Proto se mi tento přístup nelíbí, protože se při checkoutu přepisuje celá složka, aby obsahovala pouze soubory stránky, nebo projektu.

Nejvíce se mi zamlouvá použití složky docs, která je přítomna ve větvi master. Výhoda je, že při použití composeru, nebo podobných nástrojů, je z gitu stažen celý obsah, tj včetně složky docs. Může tak být k projektu vždy přítomna dokumentace pro zvolenou verzi.

Stahovat zbytečné soubory není best practise. Proto by každý repozitář měl obsahovat soubor .gitattributes a v něm zakázat stahování složky docs a dalších souborů. 

URL adresa, stránky uživatele atd.

Stránky projektu se nacházejí na adrese https://jmeno-uzivatele.github.io/nazev-projektu/. Od poloviny roku 2016 jsou již všechny nové stránky povinně na https, proto je nutné dávat pozor na mixed-content.

Lze také vytvořit stránky uživatele, ty budou na adrese https://jmeno-uzivatele.github.io. Vytvářejí se pomocí samostatného repozitáře, jehož název se musí shodovat s celou URL stránek bez protokolu. Tj. jmeno-uzivatele.github.io. V případě uživatelských stránek již musí být celé stránky přímo v master větvi.

Vlastní URL a mnoho dalšího

Stránky hostované na Githubu lze mít také na vlastní doméně. Lze využívat blogovací nástroj Jekyll, který generuje z markdown souborů statické HTML stránky. A lze také vytvářet vlastní stránky s chybovou hláškou 404. Je toho opravdu hodně, a zbytek je možné  si nastudovat v nápovědě.

---

---

Osobní zkušenosti s Github pages můžete sdílet v komentářích.