Pretvorite i pregledajte Markdown

Nadzorna ploča
Dokumentacija
API

pretvara vaš Markdown u HTML i prikazuje pregled uživo, idealno za pisanje README datoteka, dokumentacije ili članaka

Što je Markdown?

Markdown je lagani označni jezik koji je 2004. stvorio John Gruber. Omogućuje pisanje oblikovanog teksta uz jednostavnu sintaksu čitljivu i u izvornom obliku, koja se zatim pretvara u HTML.

Ovaj alat koristi specifikaciju GFM (GitHub Flavored Markdown), najraširenija inačica, koja dodaje podršku za tablice, potvrdne okvire, blokove koda sa sintaksnim isticanjem i automatske poveznice.

Pregled s desne strane ažurira se u stvarnom vremenu tijekom tipkanja. Gumb Pošalji generira odgovarajući HTML kod koji možete kopirati ili preuzeti.

Osnovna Markdown sintaksa

Markdown	Prikaz
`# Naslov 1`	Naslov <h1>
`## Naslov 2`	Naslov <h2>
`podebljano`	podebljano
`kurziv`	kurziv
`umetnuti kod`	`umetnuti kod`
```php ... ```	Blok PHP koda
`[tekst](url)`	Hiperveza
`![alt](url)`	Slika
`- stavka`	Neuređeni popis
`1. stavka`	Uređeni popis
`> citat`	Blockquote
`---`	Vodoravni razdjelnik

Uobičajeni slučajevi uporabe

GitHub README: pisanje dokumentacije projekta otvorenog koda.
Tehnička dokumentacija: pisanje vodiča, wikija ili stranica dokumentacije (MkDocs, Docusaurus, Hugo).
Članci na blogu: većina CMS sustava (Jekyll, Ghost, Contentful) prihvaća Markdown.
Komentari i prijave problema: GitHub, GitLab, Jira, Notion i Slack podržavaju GFM.
Oblikovani e-mailovi: pretvaranje Markdowna u HTML za umetanje u HTML e-mail.
Bilješke i prezentacije: Obsidian, Notion, Marp i Reveal.js koriste Markdown.

Često postavljana pitanja

Koja je razlika između standardnog Markdowna i GFM-a?

Standardni Markdown (CommonMark) pokriva osnovne elemente: naslove, popise, poveznice, kod. GFM (GitHub Flavored Markdown) dodaje tablice, popise zadataka (- [ ] stavka), ograđeni kod s jezikom (```php), spominjanja i automatske poveznice. Ovaj alat koristi GFM putem biblioteke league/commonmark.

Je li generirani HTML siguran?

Da. Pretvarač je konfiguriran da uklanja sirove HTML oznake (html_input: strip) i blokira nesigurne poveznice, čime se sprječavaju XSS napadi. Proizvedeni HTML prikladan je za umetanje u postojeću web stranicu.

Mogu li uključiti HTML u svoj Markdown?

Iz sigurnosnih razloga, sirovi HTML umetnut u Markdown uklanja se tijekom pretvorbe. Ako trebate prilagođeni HTML prikaz, napišite ciljani HTML izravno.

Koja je najveća veličina dokumenta?

Za ovaj alat ne postoji stroga granica na strani poslužitelja. Za vrlo duge dokumente (više od nekoliko tisuća redaka), pregled u stvarnom vremenu može usporiti ovisno o vašem pregledniku.

Primjer zahtjeva

curl -X POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute \
  -H "Content-Type: application/json" \
  -d '{"input":"..."}'

Ulazna shema

Polje	Tip	Obavezno	Zadano
`input`	text		–

Krajnje točke

GET https://cdrn.fr/api/v1/tools - ispisuje sve dostupne alate
GET https://cdrn.fr/api/v1/tools/markdown-formatter - dohvaća shemu ovog alata
POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - izvršava ovaj alat s JSON payloadom