Previesť a zobraziť náhľad Markdownu

Dashboard
Dokumentácia
API

prevedie váš Markdown na HTML a zobrazí živý náhľad, ideálne na písanie súborov README, dokumentácie alebo článkov

Čo je Markdown?

Markdown je odľahčený značkovací jazyk, ktorý vytvoril John Gruber v roku 2004. Umožňuje písať formátovaný text pomocou jednoduchej a v surovom stave čitateľnej syntaxe, ktorá sa následne prevedie na HTML.

Tento nástroj používa špecifikáciu GFM (GitHub Flavored Markdown), najrozšírenejší variant, ktorý pridáva podporu tabuliek, zaškrtávacích políčok, blokov kódu so zvýraznením syntaxe a automatických odkazov.

Náhľad vpravo sa aktualizuje v reálnom čase počas písania. Tlačidlo Odoslať vygeneruje zodpovedajúci HTML kód, ktorý môžete skopírovať alebo stiahnuť.

Základná syntax Markdown

Markdown	Výsledok
`# Nadpis 1`	Nadpis <h1>
`## Nadpis 2`	Nadpis <h2>
`tučné`	tučné
`kurzíva`	kurzíva
`inline kód`	`inline kód`
```php ... ```	Blok PHP kódu
`[text](url)`	Hypertextový odkaz
`![alt](url)`	Obrázok
`- položka`	Neusporiadaný zoznam
`1. položka`	Usporiadaný zoznam
`> citácia`	Blockquote
`---`	Vodorovný oddeľovač

Bežné prípady použitia

README na GitHube: písanie dokumentácie open source projektu.
Technická dokumentácia: písanie príručiek, wiki alebo dokumentačných stránok (MkDocs, Docusaurus, Hugo).
Blogové články: väčšina CMS systémov (Jekyll, Ghost, Contentful) podporuje Markdown.
Komentáre a issues: GitHub, GitLab, Jira, Notion a Slack podporujú GFM.
Formátované e-maily: prevod Markdownu na HTML pre integráciu do HTML e-mailu.
Poznámky a prezentácie: Obsidian, Notion, Marp a Reveal.js používajú Markdown.

Časté otázky

Aký je rozdiel medzi štandardným Markdownom a GFM?

Štandardný Markdown (CommonMark) pokrýva základné prvky: nadpisy, zoznamy, odkazy, kód. GFM (GitHub Flavored Markdown) pridáva tabuľky, zoznamy úloh (- [ ] položka), uzavretý kód s jazykom (```php), zmienky a automatické odkazy. Tento nástroj používa GFM prostredníctvom knižnice league/commonmark.

Je vygenerované HTML bezpečné?

Áno. Konvertor je nastavený tak, aby odstránil surové HTML značky (html_input: strip) a blokoval nebezpečné odkazy, čo zabraňuje útokom XSS. Vytvorené HTML je vhodné na integráciu do existujúcej webovej stránky.

Môžem vložiť HTML do svojho Markdownu?

Z bezpečnostných dôvodov sa surové HTML vložené do Markdownu pri konverzii odstráni. Ak potrebujete vlastné HTML vykreslenie, napíšte cieľové HTML priamo.

Aká je maximálna veľkosť dokumentu?

Pre tento nástroj neexistuje na strane servera prísny limit. Pri veľmi dlhých dokumentoch (viac ako niekoľko tisíc riadkov) sa náhľad v reálnom čase môže spomaliť v závislosti od vášho prehliadača.

Ukážka požiadavky

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é	Predvolené
`input`	text		–

Koncové body

GET https://cdrn.fr/api/v1/tools - vypíše všetky dostupné nástroje
GET https://cdrn.fr/api/v1/tools/markdown-formatter - získa schému tohto nástroja
POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - spustí tento nástroj s JSON payloadom