Rozdíly
Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.
Následující verze | Předchozí verze | ||
to:navody:jekyll-weby [15.02.2020 17:01] jitka.novotna vytvořeno |
to:navody:jekyll-weby [18.06.2020 08:21] (aktuální) jarmil Odkaz na zulip |
||
---|---|---|---|
Řádek 1: | Řádek 1: | ||
- | = Návod na weby = | + | ====== Jekyll weby ====== |
Tento web slouží jako výchozí stanice pro tvorbu dalších webu. Ať už regionálních nebo specializovaných celostátních. Nebojte se cokoliv přiohnout, koukejte se do dalšich pirátských webů o featurach které se vám líbí a přidejte si je do svého. | Tento web slouží jako výchozí stanice pro tvorbu dalších webu. Ať už regionálních nebo specializovaných celostátních. Nebojte se cokoliv přiohnout, koukejte se do dalšich pirátských webů o featurach které se vám líbí a přidejte si je do svého. | ||
- | == Obsah == | + | ===== Obsah ===== |
- | * [[#examplepiraticz|example.pirati.cz]] | + | * [[#examplepiraticz|example.pirati.cz]] |
- | ** [[#obsah|Obsah]] | + | * [[#obsah|Obsah]] |
- | ** [[#Úvod|Úvod]] | + | * [[#Úvod|Úvod]] |
- | ** [[#lokální-spuštění|Lokální spuštění]] | + | * [[#lokální-spuštění|Lokální spuštění]] |
- | *** [[#linux|Linux]] | + | * [[#linux|Linux]] |
- | *** [[#docker|Docker]] | + | * [[#docker|Docker]] |
- | ** [[#souborová-struktura|Souborová struktura]] | + | * [[#souborová-struktura|Souborová struktura]] |
- | *** [[#pomocné-soubory|Pomocné soubory]] | + | * [[#pomocné-soubory|Pomocné soubory]] |
- | *** [[#data|Data]] | + | * [[#data|Data]] |
- | *** [[#webové-stránky|Webové stránky]] | + | * [[#webové-stránky|Webové stránky]] |
- | ** [[#jednoduchá-změna-pomocí-github|Jednoduchá změna pomocí GitHub]] | + | * [[#jednoduchá-změna-pomocí-github|Jednoduchá změna pomocí GitHub]] |
- | *** [[#registrace-na-githubu|Registrace na Githubu]] | + | * [[#registrace-na-githubu|Registrace na Githubu]] |
- | *** [[#drobná-změna|Drobná změna]] | + | * [[#drobná-změna|Drobná změna]] |
- | *** [[#úprava-textového-souboru|Úprava textového souboru]] | + | * [[#úprava-textového-souboru|Úprava textového souboru]] |
- | *** [[#přidání-textového-souboru|Přidání textového souboru]] | + | * [[#přidání-textového-souboru|Přidání textového souboru]] |
- | *** [[#přidání-fotky|Přidání fotky]] | + | * [[#přidání-fotky|Přidání fotky]] |
- | *** [[#přidání-PDF|Přidání PDF]] | + | * [[#přidání-PDF|Přidání PDF]] |
- | *** [[#schválení-změny|Schválení změny]] | + | * [[#schválení-změny|Schválení změny]] |
- | *** [[#kontrola|Kontrola]] | + | * [[#kontrola|Kontrola]] |
- | ** [[#vkládání-obrázku|Vkládaní obrázků]] | + | * [[#vkládání-obrázku|Vkládaní obrázků]] |
- | ** [[#složitější-změny|Složitější změny]] | + | * [[#složitější-změny|Složitější změny]] |
- | ** [[#vytvoření-regionálního-webu|Vytvoření regionálního webu]] | + | * [[#vytvoření-regionálního-webu|Vytvoření regionálního webu]] |
- | *** [[#titulní-obrázek|Titulní obrázek]] | + | * [[#titulní-obrázek|Titulní obrázek]] |
- | *** [[#kontaky-na-pice|Kontaky na PiCe]] | + | * [[#kontaky-na-pice|Kontaky na PiCe]] |
- | *** [[#více-kandidátek|Více kandidátek]] | + | * [[#více-kandidátek|Více kandidátek]] |
- | *** [[#kalendář|Kalendář]] | + | * [[#kalendář|Kalendář]] |
- | ** [[#zobrazení-mapky-návrhů|Zobrazení mapky návrhů]] | + | * [[#zobrazení-mapky-návrhů|Zobrazení mapky návrhů]] |
- | ** [[#Převedení-na-vyšši-verzi-thematu|Převedení na vyšší verzi]] | + | * [[#Převedení-na-vyšši-verzi-thematu|Převedení na vyšší verzi]] |
- | ** [[#otestování-buildu|Otestování buildu]] | + | * [[#otestování-buildu|Otestování buildu]] |
- | ** [[#získání-pomoci|Získání pomoci]] | + | * [[/to/navody/jekyll-weby/assets-storage|Přenesení obrázku na Mrak]] |
+ | * [[#získání-pomoci|Získání pomoci]] | ||
- | == Úvod == | + | ===== Úvod ===== |
Pirátská strana má své weby pro veřejnost statické a umístěné na vlastním serveru. | Pirátská strana má své weby pro veřejnost statické a umístěné na vlastním serveru. | ||
Řádek 44: | Řádek 45: | ||
Repozitáře si můžete stáhnout (clone) na svůj počítač nebo k němu přistupovat pomocí githubu. Z githubu se repozitář stahuje na naše servery. | Repozitáře si můžete stáhnout (clone) na svůj počítač nebo k němu přistupovat pomocí githubu. Z githubu se repozitář stahuje na naše servery. | ||
- | Když dojde ke změně dat tak se na naších serverech repozitář zkompiluje. K tomu se používá Jekyll, ten vezme soubory z aktulání verze repozitáře, přidá k nim soubory z [https://github.com/pirati-web/jekyll-theme-pirati jekyll-theme-pirati] a vyrobí z nich samotné html & css, které pak čte webový prohlížeč. | + | Když dojde ke změně dat tak se na naších serverech repozitář zkompiluje. K tomu se používá Jekyll, ten vezme soubory z aktulání verze repozitáře, přidá k nim soubory z [[https://github.com/pirati-web/jekyll-theme-pirati|jekyll-theme-pirati]] a vyrobí z nich samotné html & css, které pak čte webový prohlížeč. |
- | == Lokální spuštění == | + | ===== Lokální spuštění ===== |
- | === Linux === | + | ==== Linux ==== |
Pozor, ruby je peklo a samo se rozbiji, doporucujeme pouzivat docker. | Pozor, ruby je peklo a samo se rozbiji, doporucujeme pouzivat docker. | ||
Řádek 54: | Řádek 55: | ||
Instalace na Fedora 25: | Instalace na Fedora 25: | ||
- | <pre>sudo dnf group install "C Development Tools and Libraries" | + | <code> |
- | sudo dnf install ruby-devel rubygem-jekyll nodejs</pre> | + | sudo dnf group install "C Development Tools and Libraries" |
+ | sudo dnf install ruby-devel rubygem-jekyll nodejs | ||
+ | </code> | ||
Instalace Ubuntu 16.04: | Instalace Ubuntu 16.04: | ||
- | <pre>sudo apt-get install ruby-dev gcc make libghc-zlib-dev | + | <code> |
+ | sudo apt-get install ruby-dev gcc make libghc-zlib-dev | ||
gem install rubygems-update | gem install rubygems-update | ||
gem install jekyll bundler | gem install jekyll bundler | ||
- | bundle</pre> | + | bundle |
- | Repozitář můžeme naklonovat do jakékoliv složky (nemusí být ve <code>/var/www/</code>). | + | </code> |
+ | Repozitář můžeme naklonovat do jakékoliv složky (nemusí být ve ''%%/var/www/%%''). | ||
Po stažení nové verze může být potřeba: | Po stažení nové verze může být potřeba: | ||
- | <pre>bundle install --path vendor/bundle</pre> | + | <code> |
+ | bundle install --path vendor/bundle | ||
+ | </code> | ||
Spustění je pomocí | Spustění je pomocí | ||
- | <pre>bundle exec jekyll serve --watch --livereload</pre> | + | <code> |
- | , což stránku zkompiluje, spustí a ještě je stránka přístupná skrz [http://127.0.0.1:4000 localhost] | + | bundle exec jekyll serve --watch --livereload |
+ | </code> | ||
+ | , což stránku zkompiluje, spustí a ještě je stránka přístupná skrz [[http://127.0.0.1:4000|localhost]] | ||
- | V některých případech (př ubuntu a systémová i bundle verze jekyllu) je nuté říct jaký jakyll použít <code>bundle exec vendor/bundle/ruby/2.5.0/gems/jekyll-3.7.3/exe/jekyll server --watch --livereload</code> | + | V některých případech (př ubuntu a systémová i bundle verze jekyllu) je nuté říct jaký jakyll použít ''%%bundle exec vendor/bundle/ruby/2.5.0/gems/jekyll-3.7.3/exe/jekyll server --watch --livereload%%'' |
- | Popřípadě můžeme spustit jen: <code>jekyll build</code>, což do složky <code>_site</code> připraví kompletní web (ten můžeme otevřít z prohlíže pomocí klavesové zkratky <code>ctrl+o</code>). | + | Popřípadě můžeme spustit jen: ''%%jekyll build%%'', což do složky ''%%_site%%'' připraví kompletní web (ten můžeme otevřít z prohlíže pomocí klavesové zkratky ''%%ctrl+o%%''). |
- | === Docker === | + | ==== Docker ==== |
instalujte docker podle návodu na váš operační systém (anglicky) | instalujte docker podle návodu na váš operační systém (anglicky) | ||
- | * [https://docs.docker.com/docker-for-windows/install/ Windows] | + | * [[https://docs.docker.com/docker-for-windows/install/|Windows]] |
- | * [https://docs.docker.com/docker-for-mac/install/ macOS] | + | * [[https://docs.docker.com/docker-for-mac/install/|macOS]] |
- | * [https://docs.docker.com/install/linux/docker-ce/ubuntu/ Ubuntu] | + | * [[https://docs.docker.com/install/linux/docker-ce/ubuntu/|Ubuntu]] |
- | * [https://docs.docker.com/install/linux/docker-ce/fedora/ Fedora] | + | * [[https://docs.docker.com/install/linux/docker-ce/fedora/|Fedora]] |
- | a ověřte že máte <code>docker-compose</code> [https://docs.docker.com/compose/install/ official resources] a spušteného demona. Pak stačí: | + | a ověřte že máte ''%%docker-compose%%'' [[https://docs.docker.com/compose/install/|official resources]] a spušteného demona. Pak stačí: |
- | <pre>docker-compose up</pre> | + | <code> |
+ | docker-compose up | ||
+ | </code> | ||
Za vylepšení tohoto návodu budeme rádi. | Za vylepšení tohoto návodu budeme rádi. | ||
- | == Souborová struktura == | + | ===== Souborová struktura ===== |
- | === Pomocné soubory === | + | ==== Pomocné soubory ==== |
- | * <code>Gemfile</code> se soubor “knihoven” které potřebuje Jekyll, nastavit v něm můžete např verzi thema které použijete. <code>Gemfile.lock</code> je pomocný soubor pro stejnou věc. | + | * ''%%Gemfile%%'' se soubor “knihoven” které potřebuje Jekyll, nastavit v něm můžete např verzi thema které použijete. ''%%Gemfile.lock%%'' je pomocný soubor pro stejnou věc. |
- | * <code>_config.yml</code> slouží jako hlavní návod pro Jekyll jak překládat, vyplňuji se v něm důležité texty a odkazy a taky nastavují některé parametry thema | + | * ''%%_config.yml%%'' slouží jako hlavní návod pro Jekyll jak překládat, vyplňuji se v něm důležité texty a odkazy a taky nastavují některé parametry thema |
- | * <code>Dockerfile</code> a <code>docker-compose.yml</code> slouží k lokálnímu spuštění webu. | + | * ''%%Dockerfile%%'' a ''%%docker-compose.yml%%'' slouží k lokálnímu spuštění webu. |
- | * <code>README.md</code> je tento text. | + | * ''%%README.md%%'' je tento text. |
- | * <code>_site</code> a <code>vendor</code> jsou složky viditelné jen při lokálním spuštení. V <code>_site</code> jsou výsledné html stránky. V <code>vendor</code> jsou uložené “knihovny”. | + | * ''%%_site%%'' a ''%%vendor%%'' jsou složky viditelné jen při lokálním spuštení. V ''%%_site%%'' jsou výsledné html stránky. V ''%%vendor%%'' jsou uložené “knihovny”. |
- | === Data === | + | ==== Data ==== |
- | * V <code>assets</code> budete použítat primárně složku <code>img</code> kam patří fotky a obrázky. | + | * V ''%%assets%%'' budete použítat primárně složku ''%%img%%'' kam patří fotky a obrázky. |
- | * <code>_posts</code>, <code>_people</code>, <code>_program</code> obsahují soubory s články, lidmi a programovými body. Soubory jsou vždy ve formátu markdown a na vrhchu mají <code>yml</code> hlavičku která je ohraničená <code>---</code>. | + | * ''%%_posts%%'', ''%%_people%%'', ''%%_program%%'' obsahují soubory s články, lidmi a programovými body. Soubory jsou vždy ve formátu markdown a na vrhchu mají ''%%yml%%'' hlavičku která je ohraničená ''%%---%%''. |
- | * Složka <code>_data</code> obsahuje soubory které jsou pouze tou hlavičkou. Kromě <code>yml</code> mohou obsahovat i <code>json</code>. V <code>_data/menu.yml</code> se nastavují odkazy v horní liště, menu i na spodu stránky. | + | * Složka ''%%_data%%'' obsahuje soubory které jsou pouze tou hlavičkou. Kromě ''%%yml%%'' mohou obsahovat i ''%%json%%''. V ''%%_data/menu.yml%%'' se nastavují odkazy v horní liště, menu i na spodu stránky. |
- | === Webové stránky === | + | ==== Webové stránky ==== |
- | Samotné stránky jsou v markdownu nebo v html (složitější struktura, např. vícesloupců apod) * <code>index.html</code> popisuje titulní stránky * v dalších složkách jako je např <code>kontakt</code> nebo <code>lide</code> najdeme popis stránek, které budou na ''example.pirati.cz/kontakt/'' resp ''example.pirati.cz/lide/'' krom indexu tam lze přidávat další stránky pokud např v <code>komunalni-volby</code> přidáte soubor <code>harmonogram.md</code> ve správném formátu, tak vyrobíte stránku ''example.pirati.cz/komunalni-volby/harmonogram.html'' * obrázek se do stránky (i v markdown formátu) vkládá pomocí kódu <code>{% asset 'posts/jmeno_obrazku.jpg' alt='Popis obrázku' %}</code> přičemž obrázek ''assets/img/posts/jmeno_obrazku.jpg'' musí existovat; kromě parametru ''alt'' je možné použít parametr magick pro úpravu obrázku, např.: <code>magick:resize='200x'</code>, kompletní dokumentace je k dispozici [https://github.com/envygeeks/jekyll-assets zde] | + | Samotné stránky jsou v markdownu nebo v html (složitější struktura, např. vícesloupců apod) * ''%%index.html%%'' popisuje titulní stránky * v dalších složkách jako je např ''%%kontakt%%'' nebo ''%%lide%%'' najdeme popis stránek, které budou na //example.pirati.cz/kontakt/// resp //example.pirati.cz/lide/// krom indexu tam lze přidávat další stránky pokud např v ''%%komunalni-volby%%'' přidáte soubor ''%%harmonogram.md%%'' ve správném formátu, tak vyrobíte stránku //example.pirati.cz/komunalni-volby/harmonogram.html// * obrázek se do stránky (i v markdown formátu) vkládá pomocí kódu ''%%{% asset 'posts/jmeno_obrazku.jpg' alt='Popis obrázku' %}%%'' přičemž obrázek //assets/img/posts/jmeno_obrazku.jpg// musí existovat; kromě parametru //alt// je možné použít parametr magick pro úpravu obrázku, např.: ''%%magick:resize='200x'%%'', kompletní dokumentace je k dispozici [[https://github.com/envygeeks/jekyll-assets|zde]] |
- | == Jednoduchá změna pomocí GitHub == | + | ===== Jednoduchá změna pomocí GitHub ===== |
Rozlišujeme dva typy uživatelů. Prvními jsou lidé pouze zaregistrovaný na githubu může navrhnout změnu kdekoliv. Druhými jsou správci (collaborants) ti můžou rovnou přispívat a schvalovat změny. | Rozlišujeme dva typy uživatelů. Prvními jsou lidé pouze zaregistrovaný na githubu může navrhnout změnu kdekoliv. Druhými jsou správci (collaborants) ti můžou rovnou přispívat a schvalovat změny. | ||
Řádek 116: | Řádek 127: | ||
Pro jednoduché weby doporučujeme mít pouze dva správce, jednoho ‘editora’ který na web dáva články informace a na začátku ho plnil a druhého technicky zdatného, který řeší problémy a dělat velké změny. Ostatní přispěvatelé mohou navrhovat změny. | Pro jednoduché weby doporučujeme mít pouze dva správce, jednoho ‘editora’ který na web dáva články informace a na začátku ho plnil a druhého technicky zdatného, který řeší problémy a dělat velké změny. Ostatní přispěvatelé mohou navrhovat změny. | ||
- | === Registrace na Githubu === | + | ==== Registrace na Githubu ==== |
- | Registrujte se [https://github.com/join?source=header-home tady] jako username doporučuji zvolit reálné jméno a přidat i fotku. Usnadníte tím práci editorům a celkovou spolupráci pirátu na webech. | + | Registrujte se [[https://github.com/join?source=header-home|tady]] jako username doporučuji zvolit reálné jméno a přidat i fotku. Usnadníte tím práci editorům a celkovou spolupráci pirátu na webech. |
- | === Drobná změna === | + | ==== Drobná změna ==== |
Jako je např. oprava gramatické chyby nebo přidání telefoního čísla. | Jako je např. oprava gramatické chyby nebo přidání telefoního čísla. | ||
Řádek 128: | Řádek 139: | ||
Existuje ještě elegantní trik jak se dostat k editaci: přímo na samotném webu najít vpravo dole tlačítko navrhnout změnu. | Existuje ještě elegantní trik jak se dostat k editaci: přímo na samotném webu najít vpravo dole tlačítko navrhnout změnu. | ||
- | === Úprava textového souboru === | + | ==== Úprava textového souboru ==== |
- | Většina souborů se samotným textem jsou ve formánu [https://cs.wikipedia.org/wiki/Markdown markdown] do kterého můžěte psát i html značky. | + | Většina souborů se samotným textem jsou ve formánu [[https://cs.wikipedia.org/wiki/Markdown|markdown]] do kterého můžěte psát i html značky. |
- | === Přidání textového souboru === | + | ==== Přidání textového souboru ==== |
Na githubu najeďte do složky, kam chcete soubor přidat, a klidněte na “create new file”. Doporučuji si zároveň otevřít jiný soubor z dané složky, ať z něj můžete zkopírovat strukturu a vyměnit jenom data. | Na githubu najeďte do složky, kam chcete soubor přidat, a klidněte na “create new file”. Doporučuji si zároveň otevřít jiný soubor z dané složky, ať z něj můžete zkopírovat strukturu a vyměnit jenom data. | ||
- | === Přidání fotky === | + | ==== Přidání fotky ==== |
Fotky může přidávat pouze ‘editor’. Fotky přidávejte v dostatečném rozlišení (lepší větší než menší). Web si fotky sám škáluje a ořezává podle toho, v jakém formátu je zrovna na daném místě potřebuje. | Fotky může přidávat pouze ‘editor’. Fotky přidávejte v dostatečném rozlišení (lepší větší než menší). Web si fotky sám škáluje a ořezává podle toho, v jakém formátu je zrovna na daném místě potřebuje. | ||
Řádek 142: | Řádek 153: | ||
Fotky osob je dobré dodávat ve čtvercovém formátu, protože jejich profilové fotky, jsou vždycky čtvercové. Tím zamezíte nechtěným ořezům hlav lidí atp. | Fotky osob je dobré dodávat ve čtvercovém formátu, protože jejich profilové fotky, jsou vždycky čtvercové. Tím zamezíte nechtěným ořezům hlav lidí atp. | ||
- | Pokud potřebujete použít stejnou funkcionalitu i na jiném místě ve vaší kopii webu, mrkntěte na použítí [https://github.com/pirati-web/jekyll-theme-pirati/blob/master/_includes/people/profile-badge.html#L12 tady] a [https://github.com/envygeeks/jekyll-assets tady]. | + | Pokud potřebujete použít stejnou funkcionalitu i na jiném místě ve vaší kopii webu, mrkntěte na použítí [[https://github.com/pirati-web/jekyll-theme-pirati/blob/master/_includes/people/profile-badge.html#L12|tady]] a [[https://github.com/envygeeks/jekyll-assets|tady]]. |
- | === Přidání PDF === | + | ==== Přidání PDF ==== |
- | # pdf přejmenujte, aby vněm nebyli mezery či háčky a tím pádem nemělo ošklivou url | + | - pdf přejmenujte, aby vněm nebyli mezery či háčky a tím pádem nemělo ošklivou url |
- | # uložte jej do složky pirati.cz/assets/pdf či nahrajte na patřičné místo v github rozhraní | + | - uložte jej do složky pirati.cz/assets/pdf či nahrajte na patřičné místo v github rozhraní |
- | # commitněte změny | + | - commitněte změny |
- | # ověřte si že je existuje na adrese: https://pirati.cz/assets/pdf/nazev-dokumentu.pdf | + | - ověřte si že je existuje na adrese: https:%%//%%pirati.cz/assets/pdf/nazev-dokumentu.pdf |
- | # můžete tiskovu a do ní dejte ten výse zmíniný odkaz! | + | - můžete tiskovu a do ní dejte ten výse zmíniný odkaz! |
- | Pokud vložíte odkaz přímo na github tak čtenář dostane pro něj nesrozumitnelnou a nechutnou hlavičku githubu: https://github.com/pirati-web/pirati.cz/blob/gh-pages/assets/pdf/dr-stiznost-fin.pdf Pokud vložíte odkaz přímo na naše stránky je náhled mnohem hezčí: https://www.pirati.cz/assets/pdf/dr-stiznost-fin.pdf | + | Pokud vložíte odkaz přímo na github tak čtenář dostane pro něj nesrozumitnelnou a nechutnou hlavičku githubu: https:%%//%%github.com/pirati-web/pirati.cz/blob/gh-pages/assets/pdf/dr-stiznost-fin.pdf Pokud vložíte odkaz přímo na naše stránky je náhled mnohem hezčí: https:%%//%%www.pirati.cz/assets/pdf/dr-stiznost-fin.pdf |
- | === Schválení změny === | + | ==== Schválení změny ==== |
Na hlavní stránce nahoře je pole “merge request” - tam se nachází seznam návrhů. Projděte si je, rozklikejte je a po kontrole můžete kliknout na “merge pull request” a následně “confirm merge”. | Na hlavní stránce nahoře je pole “merge request” - tam se nachází seznam návrhů. Projděte si je, rozklikejte je a po kontrole můžete kliknout na “merge pull request” a následně “confirm merge”. | ||
- | === Kontrola === | + | ==== Kontrola ==== |
Pokud děláte změny takto přes github, může dojít k chybě, které si hned nevšimnete. Proto je po změně potřeba zkontrolovat, že se vše povedlo. Nicméně buťte trpěliví, může trvat až pět minut než se změna projeví. Existují tři typy chyb: | Pokud děláte změny takto přes github, může dojít k chybě, které si hned nevšimnete. Proto je po změně potřeba zkontrolovat, že se vše povedlo. Nicméně buťte trpěliví, může trvat až pět minut než se změna projeví. Existují tři typy chyb: | ||
- | * První je, že se něco viditelně rozbije - například zmizí kus textu a vy vidíte jen “tel” a za tím nic | + | * První je, že se něco viditelně rozbije - například zmizí kus textu a vy vidíte jen “tel” a za tím nic |
- | * Druhý je, že se něco rozbije natolik, že web ani nejde přeložit. V tom případě zůstane ve staré verzi a vy nevidíte žádnou změnu. | + | * Druhý je, že se něco rozbije natolik, že web ani nejde přeložit. V tom případě zůstane ve staré verzi a vy nevidíte žádnou změnu. |
- | * Třetí a nejhorší je, že nahrajete něco, co byste na pirati.cz vůbec neměli nahrávat. Tomu zabráníte jedině tak, že pečlivě kontrolujete commity a nepustíte dál žadnou změnu, které nerozumíte. | + | * Třetí a nejhorší je, že nahrajete něco, co byste na pirati.cz vůbec neměli nahrávat. Tomu zabráníte jedině tak, že pečlivě kontrolujete commity a nepustíte dál žadnou změnu, které nerozumíte. |
To, že něco pokazíte se může stát každému. Důležité je nebát si říct o pomoc a chybu napravit. | To, že něco pokazíte se může stát každému. Důležité je nebát si říct o pomoc a chybu napravit. | ||
- | == Vkládání obrázku == | + | ===== Vkládání obrázku ===== |
Tato sekce se týká webů které již mají obrázky a fotky na mraku, pokud je tam ještě nemáte kontaktujte TO a rádi vám pomužeme s migrací. | Tato sekce se týká webů které již mají obrázky a fotky na mraku, pokud je tam ještě nemáte kontaktujte TO a rádi vám pomužeme s migrací. | ||
- | Ve vašem domovském adresáři by jste měli vidět složku <code>Assets</code> a v ní podsložku, která má stený název jako váš web (to co je před .pirati.cz) pokud ji nevidíte kontoktuje TO. V ideálním případě složku vidí a mohou do ni psát všichni členové místního MO. | + | Ve vašem domovském adresáři by jste měli vidět složku ''%%Assets%%'' a v ní podsložku, která má stený název jako váš web (to co je před .pirati.cz) pokud ji nevidíte kontoktuje TO. V ideálním případě složku vidí a mohou do ni psát všichni členové místního MO. |
- | Tato složka má stejnou strukturu jako složka assest měla v githubu. Nejdříve jsou složky <code>img</code> a <code>pdf</code> a přídaně další. Sami tam také můžete vytvořid dalši složku pro další druhy formátů. | + | Tato složka má stejnou strukturu jako složka assest měla v githubu. Nejdříve jsou složky ''%%img%%'' a ''%%pdf%%'' a přídaně další. Sami tam také můžete vytvořid dalši složku pro další druhy formátů. |
- | Do složky můžete přistoupit přímo a dokonce i automaticky resizovat obrázky, díky tomu můžete vlkádat i obrázky s relativne velkým rozlišením. Můžete si [https://wiki.pirati.cz/to/navody/asset-server odkazem ověřit], že jste fotky nahráli správně. Fotka zůstane v <code>a.pirati.cz/</code>, i pokud ji z mraku smažete. | + | Do složky můžete přistoupit přímo a dokonce i automaticky resizovat obrázky, díky tomu můžete vlkádat i obrázky s relativne velkým rozlišením. Můžete si [[https://wiki.pirati.cz/to/navody/asset-server|odkazem ověřit]], že jste fotky nahráli správně. Fotka zůstane v ''%%a.pirati.cz/%%'', i pokud ji z mraku smažete. |
- | Ve složce <code>img/posts</code> web hledá fotky k článkům. | + | Ve složce ''%%img/posts%%'' web hledá fotky k článkům. |
POZOR na název souboru. Jak nazvete soubor takové bude mít url a jelikož url moc nedává mezery a háčky tak se snažce psát jen anglickou abecetou a pomlčky. Hezké je když název vystihuje co je na fotce a zároveň není příliš dlouhý. | POZOR na název souboru. Jak nazvete soubor takové bude mít url a jelikož url moc nedává mezery a háčky tak se snažce psát jen anglickou abecetou a pomlčky. Hezké je když název vystihuje co je na fotce a zároveň není příliš dlouhý. | ||
- | Příklady dobře pojmenovaných souborů: - <code>/img/people/Ivan-Bartos.jpg</code> - <code>/img/post/zastupitele-brno-mesto.jpg</code> - <code>/img/post/Lukas_Barton_opreny.png</code> | + | Příklady dobře pojmenovaných souborů: - ''%%/img/people/Ivan-Bartos.jpg%%'' - ''%%/img/post/zastupitele-brno-mesto.jpg%%'' - ''%%/img/post/Lukas_Barton_opreny.png%%'' |
- | == Složitější změny == | + | ===== Složitější změny ===== |
- | Tento web používá [https://github.com/pirati-web/jekyll-theme-pirati jekyll-pirati-theme]. Cokoliv z něj jde přepsat. Používejte co nejnovějši verzi. Verze se nastavuje v <code>Gemfile</code> a je zmíněna i v <code>assets</code> části <code>_config.yml</code>. | + | Tento web používá [[https://github.com/pirati-web/jekyll-theme-pirati|jekyll-pirati-theme]]. Cokoliv z něj jde přepsat. Používejte co nejnovějši verzi. Verze se nastavuje v ''%%Gemfile%%'' a je zmíněna i v ''%%assets%%'' části ''%%_config.yml%%''. |
- | Pokud chcete zasahovat do JS nebo CSS tak si přečtete [https://github.com/pirati-web/jekyll-theme-pirati/blob/master/development.md dokumentaci thema] | + | Pokud chcete zasahovat do JS nebo CSS tak si přečtete [[https://github.com/pirati-web/jekyll-theme-pirati/blob/master/development.md|dokumentaci thema]] |
- | == Vytvoření regionálního webu == | + | ===== Vytvoření regionálního webu ===== |
Pokud byste tuto šablonu chtěli využít pro tvorbu webu svého místního sdružení, změňte následující: | Pokud byste tuto šablonu chtěli využít pro tvorbu webu svého místního sdružení, změňte následující: | ||
- | * v souboru <code>_config.yml</code> změňte hodnoty v horní části (title, description, url) a odkazy pod tím | + | * v souboru ''%%_config.yml%%'' změňte hodnoty v horní části (title, description, url) a odkazy pod tím |
- | * v adresáři <code>_people</code> odstraňte naše lidi a místo toho založte vlastní | + | * v adresáři ''%%_people%%'' odstraňte naše lidi a místo toho založte vlastní |
- | * v adresáři <code>assets/img/people</code> dejte fotky vašich lidí | + | * v adresáři ''%%assets/img/people%%'' dejte fotky vašich lidí |
- | * v adresáři <code>_posts</code> odstraňte vzorový blogový příspěvek a dejte vlastní | + | * v adresáři ''%%_posts%%'' odstraňte vzorový blogový příspěvek a dejte vlastní |
- | * v adresáři <code>assets/img/posts</code> odstraňte naše fotky pro blogové příspěvky a dávejte vlastní | + | * v adresáři ''%%assets/img/posts%%'' odstraňte naše fotky pro blogové příspěvky a dávejte vlastní |
- | * v souboru <code>kontakty/index.md</code> upravte doporučené kontakty, zároveň u jednoho člověka v people vyplňte <code>category</code> <code>kontaktni_osoba</code> | + | * v souboru ''%%kontakty/index.md%%'' upravte doporučené kontakty, zároveň u jednoho člověka v people vyplňte ''%%category%%'' ''%%kontaktni_osoba%%'' |
- | * v souboru <code>lide/index.html</code> upravte text a obsah stránky <code>O nas</code> | + | * v souboru ''%%lide/index.html%%'' upravte text a obsah stránky ''%%O nas%%'' |
- | === Titulní obrázek === | + | ==== Titulní obrázek ==== |
- | Přidejte široký webový a úzký mobilní obrázek a nastavte parametry v <code>_config.yml</code> | + | Přidejte široký webový a úzký mobilní obrázek a nastavte parametry v ''%%_config.yml%%'' |
- | === Kontaky na PiCe === | + | ==== Kontaky na PiCe ==== |
- | V <code>_config.yml</code> vyplně adresu PiCe a obrázek. Následně v <code>kontakty/index.html</code> nastavte <code>residence: yes</code>. | + | V ''%%_config.yml%%'' vyplně adresu PiCe a obrázek. Následně v ''%%kontakty/index.html%%'' nastavte ''%%residence: yes%%''. |
- | === Více kandidátek === | + | ==== Více kandidátek ==== |
- | To je trošku tricky nastavení, pro inspiraci se podívejte do <code>jekyll-theme-pirati</code>. | + | To je trošku tricky nastavení, pro inspiraci se podívejte do ''%%jekyll-theme-pirati%%''. |
- | === Kalendář === | + | ==== Kalendář ==== |
Pro vložení kaledáře existují dvě cesty: | Pro vložení kaledáře existují dvě cesty: | ||
- | * '''Jednoduchá''': prostě zkopírujte adresu kalendáře pro vložení do stránky, takto vložený kalendář je zcela funkční, ale nevypadá úplně pěkně | + | * **Jednoduchá**: prostě zkopírujte adresu kalendáře pro vložení do stránky, takto vložený kalendář je zcela funkční, ale nevypadá úplně pěkně |
- | * '''Složitější''': zahrnuje nutnost získat Google Calendar API klíč, výhodou ovšem je, že kalendář bude vizuálně sladěný se zbytkem webu | + | * **Složitější**: zahrnuje nutnost získat Google Calendar API klíč, výhodou ovšem je, že kalendář bude vizuálně sladěný se zbytkem webu |
- | V případě jednoduché varianty potřebujete pouze adresu pro embeddování. Naleznete ji v nastavení kalendáře na Google Calendar webu. Tuto hodnotu vplňte v <code>_config.yml</code> do pole <code>calendar.page</code>. | + | V případě jednoduché varianty potřebujete pouze adresu pro embeddování. Naleznete ji v nastavení kalendáře na Google Calendar webu. Tuto hodnotu vplňte v ''%%_config.yml%%'' do pole ''%%calendar.page%%''. |
- | Složitější postup není ve skutečnosti nikterak komplikovaný. Budete potřebovat získat ID kalendáře (napište ho do <code>calendar.id</code>), které je také k dispozici na Google Calendar webu. Následně ještě budete potřebovat Google Calendar API key a domluvit se se správcem webu aby vám ho zapnul. | + | Složitější postup není ve skutečnosti nikterak komplikovaný. Budete potřebovat získat ID kalendáře (napište ho do ''%%calendar.id%%''), které je také k dispozici na Google Calendar webu. Následně ještě budete potřebovat Google Calendar API key a domluvit se se správcem webu aby vám ho zapnul. |
- | API klíč získáte v [https://console.developers.google.com Google Developer Consoli]. Nejprve si vytvořte nový projekt (třeba example.pirati.cz). Poté je nutné přes “Enable APIs and services” povolit pro projekt <code>Google Calendar API</code>. Poté si vytvořte samotný API klíč. To provedete tak, že kliknete na “Create credentials” v sekci [https://console.developers.google.com/apis/credentials Credentials]. Jako typ vyberete “API key” a výsledkem bude změť písmen a znaků, které tvoří samotný klíč. Je vhodné pomocí “Restrict key” omezit adresy, na kterých klíč může být používán, aby vám ho někdo neukradnul. V “Application restrictions” vyberte “HTTP referers” a vyplňte všechny adresy, na kterých web chcete provozovat (např. <code>https://example.pirati.cz</code>, vždy jedna na řádek). Pokud chcete udělat klíč pro lokální vývoj (např. <code>http://localhost:4000</code>), doporučujeme si na to udělat samostatný klíč a ten nikomu neukazovat aby se předešlo zneužití (protože <code>localhost</code> vlastní každý). | + | API klíč získáte v [[https://console.developers.google.com|Google Developer Consoli]]. Nejprve si vytvořte nový projekt (třeba example.pirati.cz). Poté je nutné přes “Enable APIs and services” povolit pro projekt ''%%Google Calendar API%%''. Poté si vytvořte samotný API klíč. To provedete tak, že kliknete na “Create credentials” v sekci [[https://console.developers.google.com/apis/credentials|Credentials]]. Jako typ vyberete “API key” a výsledkem bude změť písmen a znaků, které tvoří samotný klíč. Je vhodné pomocí “Restrict key” omezit adresy, na kterých klíč může být používán, aby vám ho někdo neukradnul. V “Application restrictions” vyberte “HTTP referers” a vyplňte všechny adresy, na kterých web chcete provozovat (např. ''%%https://example.pirati.cz%%'', vždy jedna na řádek). Pokud chcete udělat klíč pro lokální vývoj (např. ''%%http://localhost:4000%%''), doporučujeme si na to udělat samostatný klíč a ten nikomu neukazovat aby se předešlo zneužití (protože ''%%localhost%%'' vlastní každý). |
Mějte na paměti, že s klíčem máte právo kromě čtení také věci editovat. | Mějte na paměti, že s klíčem máte právo kromě čtení také věci editovat. | ||
- | Jakmile máte platný klíč, tento klíč předejte správci, který s vámi řeší uvedení webu do provozu. Řekněte mu, že potřebujete nastavit tzv. environment variable <code>GOOGLE_CALENDAR_APIKEY</code> na hodnotu klíče, kterou jste předtím získali v Developer Consoli. Poté bude váš kalendář vypadat jako např. na [https://pardubice.pirati.cz pardubickém webu]. | + | Jakmile máte platný klíč, tento klíč předejte správci, který s vámi řeší uvedení webu do provozu. Řekněte mu, že potřebujete nastavit tzv. environment variable ''%%GOOGLE_CALENDAR_APIKEY%%'' na hodnotu klíče, kterou jste předtím získali v Developer Consoli. Poté bude váš kalendář vypadat jako např. na [[https://pardubice.pirati.cz|pardubickém webu]]. |
- | == Zobrazení mapky návrhů == | + | ===== Zobrazení mapky návrhů ===== |
- | Implementace mapky návrhů byla ve verzi 6.1.0 jekyll-theme-piráti upravena, nyní je mapový podklad řešen přes službu [https://www.mapbox.com/ Mapbox]. | + | Implementace mapky návrhů byla ve verzi 6.1.0 jekyll-theme-piráti upravena, nyní je mapový podklad řešen přes službu [[https://www.mapbox.com/|Mapbox]]. |
- | Abyste mapičku zobrazili, je nutné si tam vytvořit účet a následně získáte ''access token''. Ten pak při spuštění stránek poskytnete pomocí environment variable <code>MAPBOX_ACCESS_TOKEN</code>. Následně můžete do kterékoliv stránky přidat kód podobný tomuto: | + | Abyste mapičku zobrazili, je nutné si tam vytvořit účet a následně získáte //access token//. Ten pak při spuštění stránek poskytnete pomocí environment variable ''%%MAPBOX_ACCESS_TOKEN%%''. Následně můžete do kterékoliv stránky přidat kód podobný tomuto: |
- | <pre>{% if site.env.MAPBOX_ACCESS_TOKEN %} | + | <code> |
- | <div class="__vue-root" data-app="IntentionMap" data-accesstoken="{{ site.env.MAPBOX_ACCESS_TOKEN }}" data-dataset="https://gist.githubusercontent.com/xaralis/f9711e5d12f971504d0753ba40c3d33e/raw/4a1701c64de5eb7ed6aa1538cb269022965d82d6/map.geojson" data-ideaform="https://goo.gl/forms/wKSPmWNDzgRiUxLN2"></div> | + | {% if site.env.MAPBOX_ACCESS_TOKEN %} |
- | {% endif %}</pre> | + | <div class="__vue-root" data-app="IntentionMap" data-accesstoken="{{ site.env.MAPBOX_ACCESS_TOKEN }}" data-dataset="https://gist.githubusercontent.com/xaralis/f9711e5d12f971504d0753ba40c3d33e/raw/4a1701c64de5eb7ed6aa1538cb269022965d82d6/map.geojson" data-ideaform="https://goo.gl/forms/wKSPmWNDzgRiUxLN2"></div> |
- | Jak je vidět, potřebujete nějaký geojson soubor, který definuje jednotlivé položky na mapě. Pro vytvoření mapového podkladu můžete využít libovolný GeoJSON editor, např. <code>http://geojson.io</code>. Aby mapa záměrů správně fungovala, měly by jednotlivé položky mapy mít následující atributy: | + | {% endif %} |
+ | </code> | ||
+ | Jak je vidět, potřebujete nějaký geojson soubor, který definuje jednotlivé položky na mapě. Pro vytvoření mapového podkladu můžete využít libovolný GeoJSON editor, např. ''%%http://geojson.io%%''. Aby mapa záměrů správně fungovala, měly by jednotlivé položky mapy mít následující atributy: | ||
- | * <code>id</code> - jedinečný identifikátor záměru, celé číslo | + | * ''%%id%%'' - jedinečný identifikátor záměru, celé číslo |
- | * <code>name</code> - definuje jméno záměru na mapě | + | * ''%%name%%'' - definuje jméno záměru na mapě |
- | * <code>category</code> - definuje kategorii záměru | + | * ''%%category%%'' - definuje kategorii záměru |
- | * <code>description</code> - definuje detailní popis záměru | + | * ''%%description%%'' - definuje detailní popis záměru |
- | * <code>image</code> (volitelné) - URL obrázku záměru | + | * ''%%image%%'' (volitelné) - URL obrázku záměru |
- | Pomocí atributu <code>data-ideaform</code> lze volitelně připojit i link na formulář, kam vám veřejnost může zasílat své nápady. | + | Pomocí atributu ''%%data-ideaform%%'' lze volitelně připojit i link na formulář, kam vám veřejnost může zasílat své nápady. |
- | Editace mapy záměrů se provádí nahráním souboru přímo na webu geojson.io přes Open -> File. Soubor lze vzít z Gitu kterékoli mutace webu, která ho již má a upravit dle vlastních potřeb. | + | Editace mapy záměrů se provádí nahráním souboru přímo na webu geojson.io přes Open -> File. Soubor lze vzít z Gitu kterékoli mutace webu, která ho již má a upravit dle vlastních potřeb. |
- | == Otestování buildu == | + | ===== Otestování buildu ===== |
Pokud chcete otestovat, jaké stránky se vám při nasazení vygenerují, spusťte následující příkaz: | Pokud chcete otestovat, jaké stránky se vám při nasazení vygenerují, spusťte následující příkaz: | ||
- | <pre>JEKYLL_ENV=production bundle exec jekyll build</pre> | + | <code> |
- | Výsledné stránky jsou uloženy v adresáři <code>_site</code>. Je vhodné následně ještě spustit [https://github.com/gjtorikian/html-proofer html-proofer] pro ověření, že všechny odkazy, které na webu máte, někam vedou: | + | JEKYLL_ENV=production bundle exec jekyll build |
+ | </code> | ||
+ | Výsledné stránky jsou uloženy v adresáři ''%%_site%%''. Je vhodné následně ještě spustit [[https://github.com/gjtorikian/html-proofer|html-proofer]] pro ověření, že všechny odkazy, které na webu máte, někam vedou: | ||
- | <pre>bundle exec htmlproofer --assume-extension --disable-external --url-ignore "#,#fn:1" ./_site</pre> | + | <code> |
+ | bundle exec htmlproofer --assume-extension --disable-external --url-ignore "#,#fn:1" ./_site | ||
+ | </code> | ||
Pokud tento příkaz selže, znamená to, že jste nejspíš někde uvedli špatnou adresu. | Pokud tento příkaz selže, znamená to, že jste nejspíš někde uvedli špatnou adresu. | ||
- | Můžete také využít příkaz <code>build.sh</code>, který obsahuje oba výše zmíněné příkazy: | + | Můžete také využít příkaz ''%%build.sh%%'', který obsahuje oba výše zmíněné příkazy: |
- | <pre>./build.sh</pre> | + | <code> |
- | == Převedení na vyšši verzi thematu == | + | ./build.sh |
+ | </code> | ||
+ | ===== Převedení na vyšši verzi thematu ===== | ||
- | Nejprve se podívejte jaká [https://github.com/pirati-web/jekyll-theme-pirati/releases verze] je poslední. Pak se podívejte do <code>Gemfile</code> a dolů do souboru <code>_config.yml</code> tam by měla být vaše aktuální verze. | + | Nejprve se podívejte jaká [[https://github.com/pirati-web/jekyll-theme-pirati/releases|verze]] je poslední. Pak se podívejte do ''%%Gemfile%%'' a dolů do souboru ''%%_config.yml%%'' tam by měla být vaše aktuální verze. |
Pokud aktuální používaná verze a poslední verze začínaji stejným číslem stačí to číslo zvýšit, lokálně otestovat, že se nic nerozbilo a pushnout. | Pokud aktuální používaná verze a poslední verze začínaji stejným číslem stačí to číslo zvýšit, lokálně otestovat, že se nic nerozbilo a pushnout. | ||
- | Pokud se liší v hlavním číšle je třeba udělat další změny podle [https://github.com/pirati-web/jekyll-theme-pirati/blob/master/README.md návodu] | + | Pokud se liší v hlavním číšle je třeba udělat další změny podle [[https://github.com/pirati-web/jekyll-theme-pirati/blob/master/README.md|návodu]] |
- | == Statistiky přístupů - Piwik/Matomo == | + | ===== Statistiky přístupů - Piwik/Matomo ===== |
- | Pro generování statistik je možné použít [https://matomo.org/ Matomo] (před přejmenováním Piwik), což je otevřená alternativa ke Google Analytics. Je k tomu potřeba: | + | Pro generování statistik je možné použít [[https://matomo.org/|Matomo]] (před přejmenováním Piwik), což je otevřená alternativa ke Google Analytics. Je k tomu potřeba: |
- | * na [https://redmine.pirati.cz/projects/to Redmine TO] si vyžádat piwik id a napsat e-mail, na který mají chodit reporty + vybraný formát (PDF nebo HTML) | + | * na [[https://redmine.pirati.cz/projects/to|Redmine TO]] si vyžádat piwik id a napsat e-mail, na který mají chodit reporty + vybraný formát (PDF nebo HTML) |
- | * v _config.yml doplnit: | + | * v _config.yml doplnit: |
- | <pre>piwik: | + | <code> |
+ | piwik: | ||
siteId: vase_pridelene_id | siteId: vase_pridelene_id | ||
- | loadSDK: true</pre> | + | loadSDK: true |
+ | </code> | ||
Reporty standardně chodí e-mailem. Po domluvě s Martinem Rejmanem je možné získat přístup k webovému rozhraní Matomo. | Reporty standardně chodí e-mailem. Po domluvě s Martinem Rejmanem je možné získat přístup k webovému rozhraní Matomo. | ||
- | == Získání pomoci == | + | ===== Získání pomoci ===== |
- | Projděte si [http://www.kutac.cz/blog/pocitace-a-internety/git-tutorialy-a-navody/ návod na git] nebo [https://www.root.cz/knihy/pro-git/ knížku v čestine] | + | Projděte si [[http://www.kutac.cz/blog/pocitace-a-internety/git-tutorialy-a-navody/|návod na git]] nebo [[https://www.root.cz/knihy/pro-git/|knížku v čestine]] |
- | Jekyll má velmi podrobnou [http://jekyllrb.com/docs/home/ dokumentaci]. A při vývoji též doporučuji [http://jekyll.tips/jekyll-cheat-sheet/ cheat sheet] | + | Jekyll má velmi podrobnou [[http://jekyllrb.com/docs/home/|dokumentaci]]. A při vývoji též doporučuji [[http://jekyll.tips/jekyll-cheat-sheet/|cheat sheet]] |
- | Example web používá [https://github.com/pirati-web/jekyll-theme-pirati jekyll-pirati-theme]. Cokoliv z něj jde přepsat. Používejte co nejnovějši verzi. | + | Example web používá [[https://github.com/pirati-web/jekyll-theme-pirati|jekyll-pirati-theme]]. Cokoliv z něj jde přepsat. Používejte co nejnovějši verzi. |
- | Technicky přesné dotazy můžete směřovat na TODO-issue-theme nebo [https://redmine.pirati.cz/projects/to/issues/new redmine] | + | Technicky přesné dotazy můžete směřovat na TODO-issue-theme nebo [[https://redmine.pirati.cz/projects/to/issues/new|redmine]] |
- | Na cokoliv se zeptejte třeba na [https://chat.pirati.cz/channel/tech-weby chatu] | + | Na cokoliv se zeptejte třeba na [[https://zulip.pirati.cz/#narrow/stream/34-Technick.C3.BD-odbor|Zulipu TO]] |
- | Ptejte se lidí okolo vás, kteří danou věc dělali, TO a dalších. Jak říkala moje prababička “Líná huba, holé neštěstí”. | + | Ptejte se lidí okolo vás, kteří danou věc dělali, TO a dalších. Jak říkala moje prababička “Líná huba, holé neštěstí". |
+ | <hidden onHidden="Zobrazit štítek" onVisible="Skrýt štítek"> | ||
+ | ---- dataentry navod ---- | ||
+ | složka_page : to:start #organizační složka odpovědná za činnost | ||
+ | adresáts : Tvůrci webů, editoři #vymezení osob, jimž je návod určen | ||
+ | tags : web, jekyll, syntax # seznam kategorií (tagů), kterých se návod týká | ||
+ | stav_wiki : <color green>platný</color> | ||
+ | aktualizace_date : 15.02.2020 # datum poslední aktualizace textu návodu | ||
+ | ---- | ||
+ | </hidden> | ||
+ | Na tento návod odkazují [[?do=backlink|tyto stránky]]. | ||