Jak používat

Napište Markdown do editoru nebo klikněte na „Vyzkoušet příklad“ a načtěte dokument s tabulkami a seznamem úkolů.
Sledujte, jak se náhled při psaní aktualizuje. Přepněte na „Zdroj HTML“ a zobrazte vygenerovaný kód.
Zapněte nebo vypněte GitHub Flavored Markdown nebo jednoduchá zalomení řádků podle toho, kde bude text publikován.
Zkopírujte HTML do CMS nebo e-mailu, nebo si výsledek stáhněte jako soubor .html či .md.

Jak to funguje

Markdown se převádí pomocí marked, rozšířeného open-source parseru, který se řídí specifikací CommonMark a při zapnuté volbě GFM také GitHub Flavored Markdown: tabulky tvořené svislítky se zarovnáním sloupců, seznamy úkolů, ~~přeškrtnutí~~ a automatické odkazy pro holé adresy URL. Poznámky pod čarou, matematika a diagramy Mermaid nejsou součástí těchto specifikací a zobrazují se jako prostý text.

Markdown může obsahovat nezpracované HTML a toto HTML se předává beze změny, jak to dělá většina rendererů Markdownu. Pro vaši bezpečnost se náhled nikdy nevkládá do této stránky. Vykresluje se uvnitř sandboxovaného rámu, který nesmí spouštět skripty, odesílat formuláře, otevírat vyskakovací okna ani přistupovat k tomuto webu, a jeho zásady zabezpečení obsahu blokují skripty, externí styly, písma a rámy. Značka <script> nebo atribut onclick ve vašem Markdownu se zobrazí ve zdrojovém HTML, ale nikdy se nespustí. Odkazy v náhledu se zobrazují, ale neotevírají; pokud potřebujete nějaký otevřít, zkopírujte si adresu URL.

Náhled používá neutrální stylopis podobný běžným rendererům souborů README; váš web nebo GitHub může stejné HTML stylovat odlišně. Zkopírované HTML je holý fragment bez stylů; stažený soubor .html přidává základní stylopis, takže vypadá jako náhled. Stažené ani zkopírované HTML není sanitizováno, takže pokud obsahuje skripty, spustí se všude, kam ho vložíte nebo otevřete.

Příklady

Kontrola souboru README před nahráním na GitHub

Vložte soubor README.md a zkontrolujte, že sloupce tabulky jsou zarovnané, seznam úkolů se vykresluje jako zaškrtávací políčka a bloky kódu jsou správně ohraničeny, než soubor nahrajete na GitHub.

Psaní pro CMS, který přijímá HTML

Napište koncept blogového příspěvku v Markdownu, poté stiskněte tlačítko „Kopírovat HTML“ a vložte označení <h2>, <p> a <ul> do HTML editoru CMS.

Zalomení řádků ve stylu chatu

Text z chatovací aplikace má řádky oddělené jednoduchými zalomeními řádků. Zapnutím možnosti „Zacházet s jednoduchými zalomeními řádků jako <br>“ udržíte tyto řádky oddělené, místo aby se spojily do jednoho odstavce.

Časté dotazy

Je bezpečné vkládat Markdown z neznámého zdroje?

Ano, pro náhled. Vykreslené HTML se zobrazuje v sandboxovaném rámu s vypnutými skripty, takže ani značka <script> nebo obsluha události v textu zde nic neprovede. Buďte opatrní, kam vkládáte exportované HTML, protože není sanitizováno.

Proč se mi nezobrazují obrázky?

Obrázky z jiných webů jsou ve výchozím nastavení blokovány, aby náhled neprováděl žádné síťové požadavky. Zapněte možnost „Načítat obrázky z jiných webů“ a zobrazí se. Relativní cesty jako ./docs/screenshot.png nemohou fungovat, protože soubory zde nejsou.

Podporuje poznámky pod čarou, matematiku nebo diagramy?

Ne. Podporuje CommonMark a GitHub Flavored Markdown (tabulky, seznamy úkolů, přeškrtnutí, automatické odkazy). Poznámky pod čarou, matematika v LaTeXu a diagramy Mermaid jsou rozšíření, která tento náhled ponechává jako prostý text.

Proč jediné zalomení řádku nezpůsobí nový řádek?

Ve standardním Markdownu se jeden konec řádku uvnitř odstavce považuje za mezeru. Ukončete řádek dvěma mezerami, nechte prázdný řádek nebo zapněte možnost „Jednoduchá zalomení řádků jako <br>“.

Soukromí

Markdown se převádí ve vašem prohlížeči a nikam se nenahrává ani neukládá. Náhled nenačítá z internetu nic, dokud nepovolíte obrázky z jiných webů; v takovém případě se tyto obrázky načítají přímo z jejich serverů.