Převod a náhled Markdownu
- Dashboard
- Dokumentace
- API
Co je Markdown?
Markdown je odlehčený značkovací jazyk, který vytvořil John Gruber v roce 2004. Umožňuje psát formátovaný text pomocí jednoduché a v surové podobě čitelné syntaxe, která se následně převede na HTML.
Tento nástroj používá specifikaci GFM (GitHub Flavored Markdown), nejrozšířenější variantu, která přidává podporu tabulek, zaškrtávacích políček, bloků kódu se zvýrazněním syntaxe a automatických odkazů.
Náhled vpravo se aktualizuje v reálném čase během psaní. Tlačítko Odeslat vygeneruje odpovídající HTML kód, který můžete zkopírovat nebo stáhnout.
Základní syntaxe Markdownu
| Markdown | Výsledek |
|---|---|
# Nadpis 1 | Nadpis <h1> |
## Nadpis 2 | Nadpis <h2> |
**tučné** | tučné |
*kurzíva* | kurzíva |
`vložený kód` | vložený kód |
```php ... ``` | Blok kódu PHP |
[text](url) | Hypertextový odkaz |
 | Obrázek |
- položka | Neuspořádaný seznam |
1. položka | Uspořádaný seznam |
> citace | Blockquote |
--- | Vodorovný oddělovač |
Běžné případy použití
- GitHub README: psaní dokumentace open source projektu.
- Technická dokumentace: psaní příruček, wiki nebo dokumentačních stránek (MkDocs, Docusaurus, Hugo).
- Články na blog: většina CMS systémů (Jekyll, Ghost, Contentful) přijímá Markdown.
- Komentáře a issues: GitHub, GitLab, Jira, Notion a Slack podporují GFM.
- Formátované e-maily: převod Markdownu na HTML pro vložení do HTML e-mailu.
- Poznámky a prezentace: Obsidian, Notion, Marp a Reveal.js používají Markdown.
Časté dotazy
Jaký je rozdíl mezi standardním Markdownem a GFM?
Standardní Markdown (CommonMark) pokrývá základní prvky: nadpisy, seznamy, odkazy, kód.
GFM (GitHub Flavored Markdown) přidává tabulky, seznamy úkolů (- [ ] položka),
ohraničený kód s jazykem (```php), zmínky a automatické odkazy.
Tento nástroj používá GFM prostřednictvím knihovny league/commonmark.
Je vygenerované HTML bezpečné?
Ano. Konvertor je nakonfigurován tak, aby odstraňoval surové HTML značky (html_input: strip)
a blokoval nebezpečné odkazy, což zabraňuje útokům XSS.
Vyprodukované HTML je vhodné pro vložení do existující webové stránky.
Mohu do svého Markdownu vložit HTML?
Z bezpečnostních důvodů je surové HTML vložené do Markdownu při převodu odstraněno. Pokud potřebujete vlastní HTML výstup, napište přímo cílové HTML.
Jaká je maximální velikost dokumentu?
Pro tento nástroj neexistuje striktní omezení na straně serveru. U velmi dlouhých dokumentů (více než několik tisíc řádků) se náhled v reálném čase může zpomalit v závislosti na vašem prohlížeči.
Ukázka požadavku
curl -X POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute \
-H "Content-Type: application/json" \
-d '{"input":"..."}'
Vstupní schéma
| Pole | Typ | Povinné | Výchozí |
|---|---|---|---|
input |
text | – |
Koncové body
GET https://cdrn.fr/api/v1/tools- vypíše všechny dostupné nástrojeGET https://cdrn.fr/api/v1/tools/markdown-formatter- získá schéma tohoto nástrojePOST https://cdrn.fr/api/v1/tools/markdown-formatter/execute- spustí tento nástroj s JSON payloadem