Markdown Preview

Co je Markdown?

Markdown je odlehčený značkovací jazyk vytvořený Johnem Gruberem v roce 2004. Ke znázornění struktury používá symboly formátování prostého textu, jako jsou hvězdičky, mřížky a pomlčky: nadpisy, tučné písmo, kurzíva, seznamy, odkazy a bloky kódu. Náhled Markdownu převádí tento prostý text na formátované HTML, takže vidíte přesně, jak bude výsledný dokument vypadat před publikováním. Původní specifikace Markdownu je popsána v dokumentaci Gruberova projektu Daring Fireball a formát byl od té doby standardizován jako CommonMark.

Markdown se stal výchozím formátem pro vývojářskou dokumentaci, soubory README, generátory statických webů (Jekyll, Hugo, Astro), wiki a znalostní báze. GitHub, GitLab, Bitbucket, Stack Overflow, Reddit a Notion podporují Markdown nativně. Protože zdrojový kód je prostý text, soubory Markdownu lze snadno verzovat pomocí Git, porovnávat mezi větvemi a slučovat bez konfliktů v nepřekrývajících se částech souboru.

Nástroj pro náhled Markdownu zpracuje váš vstup a převede ho na HTML v reálném čase. Umožňuje zachytit chyby formátování, nefunkční odkazy a neočekávané vnořování předtím, než soubor zapíšete nebo stránku zveřejníte. Tento náhled běží zcela ve vašem prohlížeči bez komunikace se serverem, takže můžete pracovat s interní nebo citlivou dokumentací bez odesílání obsahu po síti.

Proč používat online náhled Markdownu?

Psaní Markdownu v prostém editoru bez náhledu znamená, že výsledný výstup pouze odhadujete. Živý náhled tento zpětnovazební okruh okamžitě uzavře.

Případy použití náhledu Markdownu

Přehled syntaxe Markdownu

Tabulka níže mapuje běžnou syntaxi Markdownu na vykreslený výsledek a odpovídající HTML element. Pokrývá základní CommonMark, který podporuje prakticky každý parser Markdownu.

Porovnání variant Markdownu

Různé platformy rozšiřují původní specifikaci Markdownu o další funkce. Znalost cílové varianty pomáhá vyhnout se syntaxi, která v jiném rendereru tiše selže.

Příklady kódu: Programové vykreslování Markdownu

Pokud potřebujete vykreslit Markdown v aplikaci místo v nástroji v prohlížeči, použijte jednu z těchto knihoven. Každý příklad převede řetězec Markdownu na řetězec HTML.

import { marked } from 'marked'

const md = '# Hello\n\nThis is **Markdown**.'
const html = marked(md)
// → "<h1>Hello</h1>\n<p>This is <strong>Markdown</strong>.</p>\n"

// With options
marked.setOptions({ gfm: true, breaks: true })
const gfmHtml = marked('Line one\nLine two')
// → "<p>Line one<br>Line two</p>\n"

import markdown

md = '# Hello\n\nThis is **Markdown**.'
html = markdown.markdown(md)
# → '<h1>Hello</h1>\n<p>This is <strong>Markdown</strong>.</p>'

# With extensions
html = markdown.markdown(md, extensions=['fenced_code', 'tables'])

# Convert a file
with open('README.md') as f:
    html = markdown.markdown(f.read(), extensions=['extra'])

package main

import (
	"bytes"
	"fmt"
	"github.com/yuin/goldmark"
)

func main() {
	source := []byte("# Hello\n\nThis is **Markdown**.")
	var buf bytes.Buffer
	if err := goldmark.Convert(source, &buf); err != nil {
		panic(err)
	}
	fmt.Println(buf.String())
	// → <h1>Hello</h1>
	// → <p>This is <strong>Markdown</strong>.</p>
}

# Convert Markdown file to HTML
pandoc README.md -f markdown -t html -o output.html

# Convert with GitHub Flavored Markdown
pandoc README.md -f gfm -t html --standalone -o output.html

# Pipe from stdin
echo '# Hello **world**' | pandoc -f markdown -t html
# → <h1>Hello <strong>world</strong></h1>

Často kladené dotazy