Markdown je jednoduchý jazyk navržený pro zjednodušení psaní obsahu. Používá se všude, od GitHubu po aplikace pro poznámky. Ať už jste spisovatel, vývojář nebo někdo, kdo chce zjednodušit své webové psaní, tento průvodce je pro vás!
Markdown je lehký jazyk pro formátování textu, vytvořený Johnem Gruberem v roce 2004, aby byl formátovaný text snadno čitelný v textových editorech. Je obzvláště populární pro blogování, instant messaging, fóra, kolaborativní nástroje, dokumentaci a soubory readme. Časem vedly variace v jeho interpretaci k vytvoření CommonMark v roce 2014, jasnější specifikace s testovacím balíčkem pro zajímání konzistentní implementace.
Rychlý přehled nejběžnějších prvků, které budete potřebovat:
Nadpisy se vytvářejí pomocí symbolu # následovaného mezerou:
# Toto je H1
## Toto je H2
### Toto je H3Pro kurzívu použijte *hvězdičky* nebo _podtržítka_.
Pro tučné použijte **dvojité hvězdičky** nebo __dvojité podtržítka__.
Použijte hvězdičky, plus nebo minus následované mezerou:
* Položka 1
* Položka 2
* Podpoložka 2.1
* Podpoložka 2.2Jednoduše použijte čísla následovaná tečkami:
1. První položka
2. Druhá položka
3. Třetí položkaMůžete vytvořit vnitřní odkaz s následující syntaxí:
[Zobrazovaný text](URL "Volitelný titulek")Obrázky jsou podobné odkazům, ale s předchozím vykřičníkem:
Pro citace použijte znak > před vaším textem:
> Toto je citace.Pro řádkový kód obalte svůj kód zpětnými apostrofy:
`sem vložte kód` Pro víceřádkové bloky kódu použijte trojité zpětné apostrofy:
\```
Řádek 1 kódu
Řádek 2 kódu
Řádek 3 kódu
\```Horizontální čáru můžete vytvořit třemi pomlčkami, hvězdičkami nebo podtržítky:
---| Hlavička1 | Hlavička2 |
|----------|----------|
| buňka1 | buňka2 |
| buňka3 | buňka4 |- [x] Dokončený úkol
- [ ] Nedokončený úkolPoužijte ~~ k přeškrtnutí textu:
~~přeškrtnutý text~~Ve svém souboru Markdown můžete přidat citace pomocí symbolu @ následovaného klíčem citace. Například:
Podle nedávných studií [@Smith2023] je efekt...Můžete také použít více citací:
Někteří vědci argumentují tímto bodem [@Smith2023; @Doe2022].V závorce citace umístí autora a rok do závorek:
Tento jev byl pozorován v několika kontextech (např. [@Smith2023]).Vyprávěcí citace začleňují autora přímo do věty:
Podle @Smith2023 jev...K citacím můžete přidávat prefixy, ukazatele a sufixy:
Jak správně poukázali [-@Smith2023, s. 23; viz také @Doe2022, kap. 2].[@Smith2023, s. 23-25][@Doe2022, kap. 2]Poznámka: Všimněte si použití - před @Smith2023. Tímto způsobem se jméno autora neopakuje, když chcete citaci v závorce. Bez - by bylo považováno za vyprávěcí citaci.
Pro vytváření a správu bibliografie doporučujeme používat CiteDrive. CiteDrive je cloudový, kolaborativní správce referencí nativní pro BibTeX, navržený speciálně pro uživatele Overleaf, LaTeX a R Markdown. Zjednodušuje proces vytváření a exportu citací ve formátu .bib.
Zde je ukázkový záznam BibTeX, který byste mohli mít ve svém souboru .bib:
@article{Smith2023,
title = {Název studie},
author = {Smith, John},
year = 2023,
journal = {Název časopisu},
volume = 5,
pages = {10--20}
}Pandoc může konvertovat váš soubor Markdown s citacemi do správně formátovaného dokumentu pomocí CSL stylu. Zde je základní příkaz:
pandoc vášsoubor.md --citeproc --bibliography=vašeBibSoubor.bib --csl=vášCSLstyl.csl -o výstup.docxKde:
vášsoubor.md je váš soubor markdown.--citeproc umožňuje procesor citací.vašeBibSoubor.bib je váš bibliografický soubor.vášCSLstyl.csl je váš vybraný citační styl (jako APA, MLA atd.). Online je k dispozici mnoho CSL stylů.výstup.docx je požadovaný výstupní soubor (v tomto případě dokument Word).Nezapomeňte, že pro to, aby to fungovalo, budete potřebovat jak Pandoc, tak odpovídající soubory CSL. Konečný výstup bude záviset na CSL stylu, který si vyberete.