PreviewMD pro Mac, iPad a iPhone
Získat

Co je Markdown, odkud se vzal a k čemu je

Krátká odpověď: Markdown je způsob, jak psát formátovaný text do obyčejného textového souboru pomocí značek, které člověk přečte i bez programu. Řádek začínající # je nadpis, **takhle** je tučně, řádek začínající - je položka seznamu. Převodník z toho udělá HTML, člověk to přečte tak i tak. Právě ten dvojí život — čitelný jako text, vysázený jako dokument — je celá myšlenka a důvod, proč Markdown přežil každý vymakanější formát, který ho přišel nahradit.

Odkud se vzal

Markdown vydal v březnu 2004 John Gruber, který ho napsal spolu s Aaronem Swartzem. Implementací byl perlový skript o zhruba 1 400 řádcích jménem Markdown.pl a záměr byl vyslovený bez okolků: lidi, kteří píšou pro web, už unavovalo ťukat HTML značky ručně — a e-mail mezitím všechny naučil, jak se text neformálně zvýrazňuje.

Ta druhá část je podstatná, protože Markdown si své značky nevymyslel. Posbíral je z toho, co lidé v textových e-mailech dávno dělali:

  • hvězdičky kolem slova pro důraz, což Usenet a e-mail dělaly dvacet let
  • citace odpovědi odsazená znakem > na začátku řádků, což uměl každý poštovní klient
  • podtržení nadpisu znaky === nebo ---, což pochází ze Setextu, formátu Iana Feldmana z roku 1992
  • mřížka # před nadpisem, což pochází z atx, který v roce 2002 napsal Aaron Swartz

Gruberovým přínosem byl výběr a pravidlo za ním: dokument v Markdownu má číst jako obyčejný text, ne jako text zavalený značkami. Nic v syntaxi nemá na čtenáře, který o Markdownu nikdy neslyšel, působit jako kód.

Jméno je slovní hříčka na markup, tedy značkování, a původní licence byla volná natolik, že si Markdown mohl naprogramovat kdokoli — což taky každý udělal.

Proč se rozšířil

Markdown přišel bez komise, bez firmy a bez normy, a stejně je dnes všude. Zařídily to tři vlastnosti.

Je to prostý text, takže s ním každý nástroj umí pracovat. Verzovací systém ukáže rozdíl řádek po řádku a řekne ti, co se v odstavci změnilo — zkus to se souborem z textového procesoru. Vyhledávání ho najde. Skript ho umí vyrobit. Přežije poslání mailem, vložení do chatu i zkopírování zpátky. Za čtyřicet let půjde pořád otevřít.

Naučit se ho stojí asi pět minut. Se třemi značkami jsi použitelný a zbytek objevíš, až ho budeš potřebovat. Nic není schované za tlačítkem na liště.

Degraduje se slušně. Čtenář bez vysázení uvidí hvězdičky a mřížky, ale text přečte ve správném pořadí a se zjevnou strukturou. To o žádném binárním formátu neplatí.

Platformy, které ho vzaly brzy, z něj udělaly výchozí volbu. Stack Overflow spustil v roce 2008 s markdownovým editorem. GitHub vysázel README.md na stránce projektu, a od té chvíle se „napiš README v Markdownu" stalo zvykem celého oboru. Jekyll, vydaný téhož roku, uměl ze složky markdownových souborů udělat web a GitHub Pages ho zadarmo servírovaly.

V roce 2016 byl formát rozšířený natolik, že ho IANA zaregistrovala jako typ obsahu text/markdown v RFC 7763.

Dialekty a proč jich je víc

Gruberův původní popis nechal spoustu případů nedořešených — co se stane, když se seznam přeruší, jak se důraz zanořuje uvnitř slova, co znamená osamocená hranatá závorka. Každá implementace si to vyřešila po svém, takže týž soubor vypadal v různých nástrojích různě.

V roce 2014 sepsala skupina včetně Johna MacFarlanea, autora Pandocu, přesnou specifikaci i se sadou testů. Vyšla pod jménem „Standard Markdown", Gruber se proti tomu jménu ohradil, a tak se přejmenovala na CommonMark. Touhle specifikací se dnes řídí většina vysázečů.

Dialekt Co přidává Kde na něj narazíš
CommonMark Přesný základ: jednoznačná pravidla a testy Většina knihoven a editorů
GitHub Flavored Markdown Tabulky, úkoly, přeškrtnutí, automatické odkazy, poznámky pod čarou, zvýrazněné bloky GitHub, GitLab, většina README
MultiMarkdown Citace, křížové odkazy, metadata, lepší tabulky Akademické a delší texty
Pandoc Markdown Všechno výše plus matematika, obrázky a výstup do PDF, Wordu či LaTeXu Články, knihy, diplomky
MDX Komponenty psané v JSX vložené do textu Dokumentace postavené na Reactu

GFM je to, co dnes většina lidí myslí slovem Markdown: je to CommonMark plus rozšíření, která GitHub popsal v roce 2017. PreviewMD vysází právě GFM, k tomu matematiku přes KaTeX a diagramy přes Mermaid.

K čemu se používá

Dokumentace a README. Výchozí formát všeho, co čte vývojář: popisy projektů, seznamy změn, poznámky k architektuře, provozní postupy. Dokumentační weby — MkDocs, Docusaurus, Hugo, Astro — jsou většinou složky markdownových souborů s nasazeným vzhledem.

Poznámky. Obsidian, Bear, iA Writer, Logseq a tucet dalších ukládají poznámky jako soubory Markdownu, což znamená, že tvoje poznámky nejsou v pasti: přečteš je jakýmkoli editorem, zazálohuješ čímkoli a přestěhuješ se do jiné aplikace bez exportu.

Psaní pro web. Statické weby, newslettery a blogy, kde chce autor psát text, a ne značky. I stránka, kterou právě čteš, je markdownový soubor — přepínač nahoře to ukáže.

Všude, kde textové pole umí formátovat. Systémy na hlášení chyb, pull requesty, chaty, fóra a wiki používají Markdown nebo jeho blízkého příbuzného.

Řeč se stroji. Jazykové modely odpovídají v Markdownu, čímž se z něj tiše stal společný jazyk mezi lidmi a nástroji s umělou inteligencí — nadpisy, seznamy a bloky kódu, které v odpovědi vidíš, jsou vysázený Markdown.

V čem je slabý

Markdown je formát struktury, ne vzhledu. Nemá jak říct, kde co na stránce leží, jak je široký sloupec nebo jaké písmo se použije — a je to záměr, protože tahle rozhodnutí patří tomu, co dokument vysází.

Hodí se tedy špatně tam, kde je tvar stránky to hlavní: leták, formulář, časopisecká dvoustrana. Složité tabulky se sloučenými buňkami jsou kostrbaté a obvykle stejně skončí jako HTML. A na akademické psaní s citacemi a křížovými odkazy sám o sobě nestačí — přesně proto existují rozšíření Pandocu a MultiMarkdownu.

Obvyklá stížnost — „v jiné aplikaci mi to vypadá jinak" — je skoro vždycky rozdíl dialektu. Nejjistější je psát v CommonMarku plus GFM, protože na tom se shodne nejvíc nástrojů.

Markdown na Macu

macOS .md z výroby nevysází: mezerník ukáže holý text a složka poznámek vypadá jako hromada stejných prázdných ikon.

PreviewMD řeší přesně tuhle část — náhled v Quick Looku, náhledové ikony dokumentů a okno, kde je vysázená stránka vedle svého zdroje. Vysází GitHub Flavored Markdown a matematiku s diagramy nese zabalené v sobě, takže se při vykreslování nic nestahuje.

Tahák vypisuje každou značku i to, co vyrobí, a jak na Macu otevřít soubor .md řeší praktickou stránku věci.