Pretvori in predoglej Markdown

Nadzorna plošča
Dokumentacija
API

pretvori vaš Markdown v HTML in prikaže predogled v živo, idealno za pisanje datotek README, dokumentacije ali člankov

Kaj je Markdown?

Markdown je lahek označevalni jezik, ki ga je leta 2004 ustvaril John Gruber. Omogoča pisanje oblikovanega besedila z uporabo preproste in v surovi obliki berljive sintakse, ki se nato pretvori v HTML.

To orodje uporablja specifikacijo GFM (GitHub Flavored Markdown), najbolj razširjeno različico, ki dodaja podporo za tabele, potrditvena polja, bloke kode s poudarjanjem sintakse in samodejne povezave.

Predogled na desni se med tipkanjem posodablja v realnem času. Gumb Pošlji ustvari ustrezno kodo HTML, ki jo lahko kopirate ali prenesete.

Osnovna sintaksa Markdown

Markdown	Rezultat
`# Naslov 1`	Naslov <h1>
`## Naslov 2`	Naslov <h2>
`krepko`	krepko
`ležeče`	ležeče
`vrstična koda`	`vrstična koda`
```php ... ```	Blok kode PHP
`[besedilo](url)`	Hiperpovezava
`![alt](url)`	Slika
`- element`	Neurejen seznam
`1. element`	Urejen seznam
`> citat`	Blockquote
`---`	Vodoravni ločilnik

Pogosti primeri uporabe

README na GitHubu: pisanje dokumentacije odprtokodnega projekta.
Tehnična dokumentacija: pisanje vodičev, wikijev ali strani dokumentacije (MkDocs, Docusaurus, Hugo).
Blogovski članki: večina sistemov CMS (Jekyll, Ghost, Contentful) podpira Markdown.
Komentarji in issues: GitHub, GitLab, Jira, Notion in Slack podpirajo GFM.
Oblikovana e-pošta: pretvorba Markdowna v HTML za vključitev v HTML e-pošto.
Zapiski in predstavitve: Obsidian, Notion, Marp in Reveal.js uporabljajo Markdown.

Pogosta vprašanja

Kakšna je razlika med standardnim Markdownom in GFM?

Standardni Markdown (CommonMark) pokriva osnovne elemente: naslove, sezname, povezave, kodo. GFM (GitHub Flavored Markdown) dodaja tabele, sezname opravil (- [ ] element), ograjeno kodo z jezikom (```php), omembe in samodejne povezave. To orodje uporablja GFM prek knjižnice league/commonmark.

Ali je ustvarjeni HTML varen?

Da. Pretvornik je nastavljen tako, da odstrani surove oznake HTML (html_input: strip) in blokira nevarne povezave, kar preprečuje napade XSS. Ustvarjeni HTML je primeren za vključitev v obstoječo spletno stran.

Ali lahko v svoj Markdown vključim HTML?

Iz varnostnih razlogov se surovi HTML, vstavljen v Markdown, pri pretvorbi odstrani. Če potrebujete prilagojeno upodabljanje HTML, ciljni HTML napišite neposredno.

Kakšna je največja velikost dokumenta?

Za to orodje na strani strežnika ni strogih omejitev. Pri zelo dolgih dokumentih (več kot nekaj tisoč vrstic) se predogled v realnem času lahko upočasni, odvisno od vašega brskalnika.

Primer zahteve

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

Vhodna shema

Polje	Tip	Obvezno	Privzeto
`input`	text		–

Končne točke

GET https://cdrn.fr/api/v1/tools - izpiše vsa razpoložljiva orodja
GET https://cdrn.fr/api/v1/tools/markdown-formatter - pridobi shemo tega orodja
POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - izvede to orodje s JSON payloadom