Markdown Syntax
Při vytváření komentářů nebo návrhu otázek můžete pro úpravu prostého textu využít Markdown syntax, zejména pro vložení odkazu, nadpisu nebo dodání důrazu. Vložit je možné také matematické rovnice za využití MathJax, které lze pomocí LaTeX syntax převést do přívětivějšího formátu. Obecnými postupy a Markdown syntaxí se důsledně řídíme; v případě že hledáte hlubší vysvětlení o fungování tohoto systému, se obraťte přímo na Markdown. Níže jsme připravili stručný přehled nejpoužívanějších základních funkcí a návodů, jak je používat.
Formátování odkazů a vět
Odkazy lze vytvořit použitím závorek [název odkazu](http://webová-adresa-zdroje.cz
) nebo uzavřením znaky <
; a >
, např <http://www.příklad.cz>
. Existuje množství klávesových zkratek, které vám usnadní život při opakovaném používání stejného odkazu (viz zde). Výše uvedené přístupy však pokrývají 90% uživatelských případů.
Hvězdička *
i podtržení _
upraví text do _kurzívy_, dvě hvězdičky text **ztuční**. Jednoduché obrácené uvozovky označují `text -s pevnou šířkou`. Pokud chcete text menší velikosti, můžete ho uzavřít do doslovného textu: <small>html tag</small\>. Speciálních znaků `*_{}#+-.!\
přímo v těle textu, pokud by jinak byly převedeny na jiný Markdown prvek, docílíte za pomoci obráceného lomítka, např. \*
.
Nadpisy
Nadpis lze jednoduše vložit za použití znaku pro hashtag, např.:
# Nadpis první úrovně ## Nadpis druhé úrovně ##### Nadpis páté úrovně
Prosíme, používejte nadpisy v komentářích zřídka.
Citace
Pokud chcete citovat, je třeba vložit na začátek každého řádku citace znak >
:
> Toto je bloková citace s dvěma paragrafy. Lorem ipsum dolor sit amet, > consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. > Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus. > Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse > id sem consectetuer libero luctus adipiscing.
Výsledek:
Toto je bloková citace s dvěma paragrafy. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus. Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus adipiscing.
Seznamy
Za pomoci Markdown syntaxu lze vytvořit číslované i nečíslované seznamy. Např.:
1. První položka 2. Druhá položka A další odstavec v rámci druhé položky. - Podseznam položka 1. (Odsazen 4 mezerami) - Podseznam položka 2. 3. Třetí položka.
Výsledek:
- První položka
-
Druhá položka
Další odstavec v rámci druhé položky.
- Podseznam položka 1. Mějte na paměti, že je odsazen 4 mezerami.
- Podseznam položka 2.
-
Třetí položka.
Nečíslovaný seznam funguje obdobně, je třeba použít znak hvězdičky, pomlčky nebo plus k označení nové položky.
Tabulky
Podporované jsou jednoduché tabulky ve tvaru:
| Nadpis 1 | Nadpis 2 | ← nadpis |----------|----------| ← povinný oddělovač nadpisu | Buňka 1 | Buňka 2 | ← řádek 1 | Buňka 3 | Buňka 4 | ← řádek 2Sloupce jsou odděleny znakem svislé čáry | a každá řada představuje řádek, např.:
|Rok | Predikce | Celkem | |-----|-------------|--------| |2015 | 500 | 500 | |2016 | 25500 | 26000 | |2017 | 21000 | 47000 | |2018 | 63000 | 110000 | |2019 | 50000 | 160000 | |2020 | 220000 | 380000 |
Výsledek :
Rok | Predikce | Celkem |
---|---|---|
2015 | 500 | 500 |
2016 | 25500 | 26000 |
2017 | 21000 | 47000 |
2018 | 63000 | 110000 |
2019 | 50000 | 160000 |
2020 | 220000 | 380000 |
Berte ovšem v potaz, že:
- Prázdná místa před a za znakem svislé čáry jsou ignorovány.
- První a poslední znak svislé čáry každého řádku není nezbytný (neplatí pro tabulky o jednom sloupci, viz níže).
- Pomlčky v lince oddělující nadpis nejsou nezbytné.
To znamená, že následující využití syntaxu se zobrazí stejně jako příklad výše:
Rok|Predikce|Celkem || 2015|500|500 2016|25500|26000 2017|21000|47000 2018|63000|110000 2019|50000|160000 2020|220000|380000
Dále vemte v potaz, že všechny řádky tabulky musí obsahovat alespoň jeden znak svislé čáry, tzn. první (nebo poslední) znak svislé čáry je povinný pro všechny tabulky o jednom sloupci:
|U_n |- |1 |11 |21 |1211 |111221
Rozdíly a omezení
Oficiální postupy Markdown syntaxu umožňují uživatelům vkládat jakýkoliv zdrojový html kód, my však omezujeme možnosti uživatele na výše popsané prvky.
Pokud se například pokusíte vložit obrázek za pomoci [Alt text](/path/to/img.jpg)
výstup bude vypadat jako <img alt="Alt text" src="/path/to/img.jpg"/>
, tedy něco jako <script>zlověstnýKód()</script>
určitě fungovat nebude. Používáme také několik rozšíření Markdow syntaxu, která si poradí s výše popsanými bloky kodu a usnadní správu seznamů a tučného textu.