Jekyll¶

Jekyll je open source nástroj určený pro generování statických webových stránek založený v roce 2008 zakladateli GitHubu. Výsledný vygenerovaný web nemá žádný backend – v pozadí neběží žádné PHP, Java EE apod. Samotný generátor je napsaný v programovacím jazyce Ruby a renderuje markdown (odlehčený značkovací jazyk) a HTML (Hypertext Markup Language) do HTML. Stále patří společnosti GitHub a používají ho pro svou službu Github Pages. Hlavní využití má pro vývojáře k dokumentaci softwaru. Dále je využitelný pro osobní blogy a v jistých případech může být použit místo wiki.

Případy užití¶

GitHub Pages¶

Nejjednodušším způsobem je použití Jekyllu v rámci GitHubu. Webové stránky zde mohou ukazovat autorovo portfolio nebo sloužit jako dokumentace k softwaru. Není potřeba vlastnit žádnou doménu ani mít zřízený hosting, kde by staticky vygenerovaný web běžel. Stačí založit novou branch vedle naší master branch a začít web používat. Níže podrobnější návod.

Instalace¶

Instalace je pro potřeby tohoto článku ve zjednodušené formě.

1. Vytvoření repozitáře – po přihlášení se na stránkách GitHubu je potřeba vytvořit nový repozitář, jehož název bude shodný s naším uživatelským nebo jménem organizace. V případě nevalidního zadání nebude nově založený repozitář fungovat.
2. Klonování repozitáře – po úspěšném založení nového repozitáře ho naklonujeme do námi definovaného lokálního uložiště.
   
3. Vytvoření inicializačního souboru – vstoupíme do složky s projektem a vytvoříme soubor index.html.
   
4. Nahrání souboru index.html – soubor index.html je nutné v rámci adresářové struktury přidat do gitu a provést commit následovaný pushem. Do souboru je vhodné vložit nějaký text, abychom si ověřili funkčnost služby Github Pages. Následně již můžeme nahrát soubory nutné pro funkčnost Jekyllu, resp. pro jeho generování na statický obsah.
   

Po instalaci je možné zakládat nové stránky, vkládat příspěvky nebo měnit vzhled za pomocí předdefinovaných šablon nebo pomocí CSS (Cascading Style Sheets). Po každé provedené úpravě webu, resp. commitu je potřebovat vygenerovat nový statický obsah. Dle konfigurace repozitáře provádí generování GitHub automaticky nebo jej můžeme provádět manuálně.

Klasický web (blog)¶

Pro klasické blogování s Jekyllem je nutné vlastnit domému a hosting. Na hostujícím serveru je potřeba jen webový server (Apache, NGINX) – na hostingu je umístěn jen statický obsah, takže není potřeba databáze ani např. PHP (Hypertext Preprocessor) server. Nástroj Jekkyl je nainstalováný na lokálním počítači včetně všech závislostí. Počítač generuje statický obsah, který je následně nahrán na hosting.

Instalace¶

Instalace je pro potřeby tohoto článku ve zjednodušené formě.

1. Instalace závislostí – je potřeba nainstalovat Ruby, protože je v něm Jekkyl napsaný. Dále je potřeba nainstalovat knihovny gcc, gcc-c++ a zlib-devel, protože některé závislosti z Ruby se nestahují, ale kompilují.
2. Instalace Jekkylu – necháme nainstalovat Jekkyl a po instalaci Jekkylu jej necháme vygenerovat výchozí blog s výchozí šablonou.

Blog můžeme opět editovat a následně vygenerovaný statický obsah nahrát na hosting.

Vkládání příspěvků¶

Každý příspěvek je reprezentován jedním textovým souborem a Jekyll obstará vše ostatní. Příspěvek je psán v markdown nebo HTML, který obsahuje stejné formátovací značky jako GitHub. Je možnost psát i v čistém HTML. Po vytvoření příspěvku (textového souboru) musí být umístěn do složky _posts. Název souboru musí mít tento formát: ROK-MĚSÍC-DEN-NÁZEV_PŘÍSPĚVKU.MARKUP.

Do příspěvku je možné vložit odkaz na jiný příspěvek pomocí permalinku – nedochází ke kolizi URL (Uniform Resource Locator) adres při změně názvu příspěvku. Příspěvku může obsahovat mediální obsah jako jsou obrázky a různé přílohy (PDF). Příspěvky je možné kategorizovat a dávat jim tagy (Definice se provádí v hlavičce příspěvku.). Pro dosud nepublikované příspěvky (rozpracované a připravené dopředu) slouží složka drafts. Jejich náhled je možný na lokálním počítači.

Šablonovací jazyk¶

Šablonovací jazyk Liquid značně rozšiřuje možnosti příspěvků. Přidává možnost vypisovat proměnné, používat různé filtry, složitější formátování textu nebo používat logické formule. Může sloužit např. pro výpis příspěvků nebo kategorií.