Skip to content

Latest commit

 

History

History
128 lines (84 loc) · 4.14 KB

navod.md

File metadata and controls

128 lines (84 loc) · 4.14 KB

Návod pro Pirátský web

Zdrojové kódy webu: https://github.com/pirati-web/pirati.cz

Web je staticky kompilovaný v době změny, čili v repozitáři je opravdu všechno.

Správci webu: Ondřej Profant, Stanislav Štipl, Jakub Michálek, Vojta Pikal, Jan Loužek

Správci obsahu: Alexandr Kamarýt, Pavel Králíček, Jan Loužek

1. Markdown a yaml

Je třeba znát značkovací markdown, který je velmi podobný grafickému plaintextu. Markdown si můžete vyzkoušet i v online editoru s náhledem. Není třeba se ho bát. Do markdownu též můžete vložit přímo html. Například pokud chcete vložit složitější tabulku nebo google kalendář.

# Nadpis 1. úrovně

## Nadpis 2. úrovně

### Odstavce

Samostatný odstavec. Lorem ipsum. **Tučně**, *kurzíva*, [link](https://www.pirati.cz)

Odstavec se zalomením se provede  
pomocí dvou mezer na konci řádku.

1\. odstavec začínající řadovou číslovkou.

### Seznamy

1. číslovaný seznam 1
2. číslovaný seznam 2

- nečíslovaný seznam 1
- nečíslovaný seznam 2

### Obrázky

![Popisek obrázku](assets/img/brand/logo.svg)

### Citace

> Pro kratší citace zcela dostačují české úvozovky, popřípadě v kurzivě. Nicméně pro delší citace je dobré větší zdůraznění.

Yaml se používá pro zanesení metadat k článkům (stránkám). Yaml hlavičku umístíme před markdown:

key1: hodnota
key2:
  - pole
  - hodnot
key3:
  key4: val1
  key5: val2

Nejlépe je to srozumitelné na příkladu.

Github

Jedná se o systém pro sdílení verzí textových dokumentů (jako např. náš web). Umí toho mnohem více. Pro vás je důležité vytvořit si registraci.

Návrhy na změnu (pull request) se projeví až po schválení. Ale i pokud máte přímo právo zápisu, tak se změny neobjeví zcela okamžitě.

Články

Články (aktuality) je možno přidávat v grafickém rozhraní:
www.pirati.cz/admin Avšak potřebuje příslušná práva. Pro celostátní web je má MO.

Tagy

Tagy neoddělujeme čárkami, ale pouze mezerou. Zvolit správný tag není jednoduché - musí být vystižný, ale zároveň dost obecný, aby dával smysl i u dalších článků.

Lidé a další stránky

Pro jednoduchou úpravu textu stačí tlačítko vpravo dole nad patičkou "Navrhni úpravu".

Animace znázorňující navržení úpravy

Vpravo dole je "Navrhni úpravu": Přihlásíme se: Klikneme na "Fork this repository and propose changes" Nyní můžeme soubor editovat: Můžeme si i zobrazit náhled s vyznačenými změnami: Napíšeme popis změn a klikneme na "Propose file change": Nyní vidíme souhrn změn: Vytvoříme nový pull request:

Sociální sítě

Stránku je dobré otestovat ve FB debbuger, aby se správně zobrazovala při sdílení. Správné rozměry obrázku (1200 x 630)

Složitější změny

Zatím jsme prošli základy. Ale většinou není více potřeba. Pro opravdové změny je třeba ještě znát:

  • HTML, CSS, JS
  • git (pull, push, commit, merge)
  • jekyll (liquid template)

HTML

Některé stránky jsou složitější a je potřeba znalost HTML. Seznámení s HTML není obsahem tohoto návodu.

Struktura webu

  1. Kolekce začínají podtržítkem a jsou definovány v config.yaml. Včetně některých defaultních hodnot (např. obsah pravého sloupce).
  2. Stránky jsou obvykle samostatné složky obsahující soubor index.html nebo index.md. Mohou zde být i další stránky např. pripoj-se/kalendar.html.
  3. Hlavička, patička, pravý sloupec jsou ve složce _includes

Članky: 1300x744 People (lidé), foto 165x220