Úvod do Markdownu

Snížení

Markdown je nástroj pro převod textu na HTML. Dnes se stalo de facto synonymem pro třídu lehkých jazyků pro popis značek. Používá syntaxi formátování prostého textu. Myšlenkou Markdownu bylo, aby psaní webových stránek a zejména položek blogů bylo stejně snadné jako psaní e-mailu. V době listopadu 2017 je cíle dosaženo a Markdown i jeho derivace Asciidoc, Asciidoctor a Asciidoctor-pdf jsou široce používány.

Markdown se zaměřuje pouze na prostý text a zdrží se všech ostatních složitostí, které lze najít v HTML. Je snadné se to naučit, protože je to jednoduché, proto také rychlejší, protože se používá minimum znaků, což nakonec vede také k menší pravděpodobnosti chyby. Na obrázku 1 najdete základní dokument zobrazený v editoru Markdown Stackedit. Na levé straně vidíte zdrojový kód a na pravé straně odpovídající výstup HTML. Můžete si všimnout, že nadpisy jsou jednoduše označeny číslem # podle úrovně hierarchie nadpisu.

Konverze textu

Prostý text lze převést na XHTML (HTML) a mnoho dalších formátů pomocí nástrojů příkazového řádku, jako je Markdown nebo Pandoc. Oba nástroje v zásadě vytvářejí pouze fragmenty HTML a zapisují výstup do standardního výstupu. Pandoc nabízí přepínač „-o název souboru“ pro zápis výstupu HTML do daného souboru. Jak je vidět níže, je výstupní soubor pojmenován základní.html a obsahuje fragment HTML - dva nadpisy a odstavec.

$ pandoc -o základní.html základní.md $ kočka základní.html 
Jak na vytváření balíčků Debian
 
Předmluva
 Zodpovědnost za stroj znamená péči o hardware i softwarové komponenty. Jak je v každodenním životě vidět jako správce systému, je mnohem lepší instalovat software jako softwarový balíček než jako hromadu zdrojových souborů. To snižuje náklady na správnou údržbu systému. $ 

Chcete-li vytvořit samostatné dokumenty HTML s úplnou hlavičkou HTML, Pandoc přijímá přepínač „-s“ následovně:

$ pandoc -o základní.html -s základní.md $ kočka základní.html           
Jak na vytváření balíčků Debian
 
Předmluva
 Zodpovědnost za stroj znamená péči o hardware i softwarové komponenty. Jak je v každodenním životě vidět jako správce systému, je mnohem lepší instalovat software jako softwarový balíček než jako hromadu zdrojových souborů. To snižuje náklady na správnou údržbu systému.   

Výhodou zachování obsahu odděleného od vizuálního zobrazení je to, že nezkazí vzhled vašeho webu. Verze 1.0.1, který vyvinuli John Gruber a Aaron Swartz, byl vydán v prosinci 2004 a je k dispozici jako svobodný software (viz odkazy na konci tohoto článku).

Textové prvky

Nadpisy

Podle odpovídající úrovně HTML jsou nadpisy psány s počtem # takto:

# H1 ## H2 ### H3 #### H4 ##### H5 ###### H6 

Pro H1 a H2 jsou akceptovány dva alternativní způsoby zápisu:

H1 == H2 -- 

Pamatujte, že počet rovných znaků nebo pomlček musí odpovídat počtu znaků nadpisu.

Zdůraznění textu

Za účelem zdůraznění textu jsou podporovány tyto prvky:

• kurzíva: jednotlivé hvězdičky nebo jednotlivé podtržítka
  --
  * důležité * a _ také důležité_
  --
• tučný text: dvojité hvězdičky nebo dvojitá podtržítka
  --
  ** důležité ** a __ také důležité__
  --
• přeškrtnutý text: dvojité tildes
  --
  ~~ text ~~
  --

Seznamy

Markdown podporuje neuspořádané a seřazené seznamy. Uspořádané seznamy začínají hvězdičkou, znaménkem plus nebo minus. Uspořádané seznamy začínají číslicí. Chcete-li vytvořit podlisty, odsaďte listitem o dvě mezery (Markdown, StackEdit) nebo čtyři mezery (Pandoc), jak vidíte níže:

1. ovoce * jablko * banán 2. nápoje + voda + mléko 

snímky

Nejjednodušší způsob je použít inline styl následujícím způsobem:

![Logo Debianu] (debian-logo.png „Logo Debianu“) 

Zobrazí se odkazovaný obrázek. Jakmile přesunete ukazatel myši nad obrázek, zobrazí se odpovídající text popisu.

Zvýraznění kódu a syntaxe

Existují dvě varianty - vložený kód a bloky kódu. Vložený kód je orámován třemi zpětnými tahy jako „“ print („Hello, world!„)“ „. Bloky kódu také začínají a končí třemi zpětnými tahy, ale na samostatných řádcích takto:

"tisk („ Ahoj, svět!„)“

Markdown nepodporuje zvýraznění syntaxe, ale dialekty jako Markdown Here ano.

Tabulky

Markdown nepodporuje tabulky, ale rozšíření jako GFM a Markdown Here ano.

Blokové uvozovky

Blokové uvozovky začínají znakem „>“. Stává se docela užitečné citovat text.

> „Ach! je absurdní mít tvrdé a rychlé pravidlo o tom, co by měl člověk číst a co ne. Více než polovina moderní kultury závisí na tom, co by člověk neměl číst.">> Důležitost osvojení. (Oscar Wilde) 

Odkazy

Odkazy odkazují na jiné dokumenty nebo na sekce v aktuálním. Styl psaní je podobný obrázkům a skládá se z popisu odkazu v hranatých závorkách a adresy URL v běžných závorkách.

[Jsem odkaz ve stylu inline] (https: // linuxhint.com) 

Dále můžete přidat alternativní text:

[Jsem linkovaný odkaz s dalším textem] (https: // linuxhint.com „LinuxHint“) 

Na odkazy lze odkazovat takto:

[LinuxHint] [1]… nějaký text… [1]: https: // linuxhint.com 

To vám umožní snadno vytvářet seznamy odkazů na konci dokumentu, jak je to běžné ve vědeckých dokumentech.

Závěr

Markdown je docela jednoduchý a je nutností pro každého, kdo dělá dokumentaci a pravidelně publikuje obsah. Je velkým potěšením jej používat.

Reference

• StackEdit, https: // stackedit.io / editor
• Pandoc, http: // pandoc.org /
• Markdown, https: // daringfireball.síť / projekty / markdown /
• Markdown Cheatheet, https: // github.com / adam-p / markdown-here / wiki / Markdown-Cheatsheet