Markdown vysvětlen za 5 minut
Markdown jste pravděpodobně použili, aniž byste to věděli. Psali jste někdy **tučně** ve Slacku? Napsali README na GitHubu? Formátovali příspěvek na Redditu? To byl Markdown.
Markdown je odlehčený způsob formátování prostého textu pomocí jednoduchých symbolů. Místo klikání na tlačítka v nástrojové liště pro tučné písmo, kurzívu, záhlaví a seznamy napíšete několik znaků, které označují požadované formátování. Byl vytvořen v roce 2004 Johnem Gruberem a Aaronem Swartzem a stal se výchozím formátovacím jazykem pro vývojáře, pisatele a kohokoli, kdo pracuje s textem na webu.
Proč Markdown vznikl
Před Markdownem znamenalo formátování textu pro web psát HTML. Pro tučné slovo jste psali <strong>tučně</strong>. Pro vytvoření seznamu jste potřebovali <ul><li>položka</li></ul>. HTML je mocné, ale rozvláčné a v surové podobě těžko čitelné.
Markdown to řeší tím, že poskytuje lidsky čitelnou zkratku. Surový text je snadno čitelný ještě před zobrazením. Formátovaný výstup je čistý a profesionální. Dostanete to nejlepší z obou světů: čitelný zdrojový text a vybroušený výstup.
Věděli jste? Filozofie designu Markdownu spočívá v tom, že surový text by měl být „zveřejnitelný tak, jak je, jako prostý text, aniž by vypadal, jako by byl označen tagy nebo formátovacími instrukcemi." Proto syntaxe Markdownu používá znaky, které vizuálně naznačují formátování, které produkují.
Základní syntaxe
Vše, co potřebujete vědět pro produktivní používání Markdownu.
Záhlaví
Pro vytváření záhlaví používejte mřížky (#). Více mřížek znamená menší záhlaví.
# Záhlaví 1 (největší)
## Záhlaví 2
### Záhlaví 3
#### Záhlaví 4
Tučné písmo a kurzíva
Text obalte hvězdičkami nebo podtržítky:
**tučný text**
*text kurzívou*
***tučný text kurzívou***
Seznamy
Neuspořádané seznamy používají pomlčky, hvězdičky nebo znaky plus. Uspořádané seznamy používají čísla.
- První položka
- Druhá položka
- Třetí položka
1. První krok
2. Druhý krok
3. Třetí krok
Odkazy
Hranaté závorky pro text, kulaté závorky pro URL:
[Klikněte zde](https://example.com)
Obrázky
Jako odkazy, ale s vykřičníkem před nimi:
Citace
Použijte znak „větší než":
> Toto je citace. Bude odsazena a stylizována odlišně.
Kód
Zpětné uvozovky pro vložený kód, trojité zpětné uvozovky pro bloky kódu:
Pro výstup textu použijte funkci `print()`.
Pro víceřádkové bloky kódu použijte trojité zpětné uvozovky s volitelným identifikátorem jazyka:
```python
def hello():
print("Hello, world!")
```
Vodorovné čáry
Tři nebo více pomlček, hvězdičky nebo podtržítka:
---
Tabulky
Použijte svislice a pomlčky:
| Jméno | Role | Místo |
| --- | --- | --- |
| Alice | Vývojářka | Praha |
| Bob | Designer | Londýn |
Kde se Markdown používá
Markdown je všude:
Vývoj softwaru
- GitHub, GitLab, Bitbucket: README soubory, issues, pull requesty a dokumentace jsou psány v Markdownu.
- Stack Overflow: Otázky a odpovědi používají formátování Markdownu.
- Dokumentace kódu: Mnoho generátorů dokumentace (Docusaurus, MkDocs, Jekyll) používá Markdown jako zdrojový formát.
Komunikace
- Slack: Podporuje podmnožinu Markdownu pro formátování zpráv.
- Discord: Používá Markdown pro tučné písmo, kurzívu, bloky kódu a další.
- Reddit: Příspěvky a komentáře jsou formátovány Markdownem.
Psaní a publikování
- Blogy: Mnoho generátorů statických stránek používá soubory Markdown jako zdroj obsahu.
- Knihy: Některé publikační nástroje přijímají rukopisy v Markdownu.
- Poznámky: Aplikace jako Obsidian, Notion, Bear a Typora jsou postaveny na Markdownu.
Dokumentace
- Technická dokumentace: Dokumentace API, uživatelské příručky a wiki běžně používají Markdown.
- Interní znalostní báze: Mnoho týmů používá wiki založené na Markdownu.
Tip Markdown si můžete vyzkoušet a prohlédnout hned teď, zdarma, v prohlížeči: Psát v Markdownu. Formátovaný výstup vidíte v reálném čase při psaní.
Příchutě Markdownu
Je třeba vědět jedno: existují různé „příchutě" Markdownu. Základní syntaxe je všude stejná, ale některé platformy přidávají rozšíření:
| Příchuť | Navíc funkce | Používá |
|---|---|---|
| CommonMark | Přísná specifikace | Obecný standard |
| GitHub Flavored Markdown (GFM) | Úkolové seznamy, tabulky, přeškrtnutí, automatické odkazování | GitHub |
| MultiMarkdown | Poznámky pod čarou, citace, metadata | Akademické psaní |
| R Markdown | Vložený R kód, analýza dat | Datová věda |
Rozdíly jsou převážně v pokročilých funkcích. Základy (záhlaví, tučné, kurzíva, seznamy, odkazy, obrázky, kód) fungují všude stejně.
Časté chyby
Zapomínání prázdných řádků
Markdown vyžaduje prázdný řádek před a za mnoha prvky. Záhlaví potřebuje prázdný řádek před sebou. Seznam potřebuje prázdný řádek před a za ním. Zapomínání těchto prázdných řádků je nejčastějším zdrojem problémů se zobrazením.
Nekonzistentní znaky v seznamech
Míchání -, * a + ve stejném seznamu může způsobit neočekávané zobrazení. Vyberte jeden a držte se ho.
Mezery za symboly
Některé Markdown procesory vyžadují mezeru za # v záhlavích a za - v seznamech. Pro jistotu mezeru vždy zahrňte.
# Správné záhlaví
#Nesprávné záhlaví
- Správná položka seznamu
-Nesprávná položka seznamu
Varování Markdown nepokrývá všechny formátovací potřeby. Pokud potřebujete složitá rozvžení, barevný text, přesnou typografii nebo dokumenty připravené k tisku, možná budete potřebovat HTML, LaTeX nebo textový editor. Markdown je nejlepší pro strukturovaný obsah zaměřený na text.
Proč se Markdown vyplatí naučit
Markdown se naučíte za pět minut a ušetříte si hodiny v průběhu času. Jakmile ho znáte, můžete:
- Psát dokumentaci, která se krásně zobrazí na GitHubu
- Formátovat zprávy ve Slacku a Discordu bez dotyku myši
- Pořizovat strukturované poznámky přenosné mezi aplikacemi
- Vytvářet blogové příspěvky a webový obsah z prostých textových souborů
- Spolupracovat na textových dokumentech bez problémů s kompatibilitou formátů
Poměr investice k výnosu je jeden z nejlepších v celém světě technologií.
Začněte psát v Markdownu hned teď:
Zdarma, v prohlížeči, s náhledem v reálném čase při psaní.