Konvertuoti ir peržiūrėti Markdown

Skydelis
Dokumentacija
API

konvertuoja jūsų Markdown į HTML ir rodo tiesioginę peržiūrą, idealiai tinka rašyti README, dokumentaciją ar straipsnius

Kas yra Markdown?

Markdown yra lengva žymėjimo kalba, kurią 2004 m. sukūrė John Gruber. Ji leidžia rašyti suformatuotą tekstą naudojant paprastą ir net neapdorotą lengvai skaitomą sintaksę, kuri vėliau konvertuojama į HTML.

Šis įrankis naudoja GFM (GitHub Flavored Markdown) specifikaciją, labiausiai paplitusią variantą, kuris prideda lentelių, žymimųjų langelių, kodo blokų su sintaksės paryškinimu ir automatinių nuorodų palaikymą.

Peržiūra dešinėje atnaujinama realiuoju laiku rašant. Mygtukas Pateikti sugeneruoja atitinkamą HTML kodą, kurį galite kopijuoti arba atsisiųsti.

Pagrindinė Markdown sintaksė

Markdown	Rezultatas
`# Antraštė 1`	Antraštė <h1>
`## Antraštė 2`	Antraštė <h2>
`paryškinta`	paryškinta
`kursyvas`	kursyvas
`įterptasis kodas`	`įterptasis kodas`
```php ... ```	PHP kodo blokas
`[tekstas](url)`	Hipersaitas
`![alt](url)`	Paveikslėlis
`- elementas`	Nesutvarkytas sąrašas
`1. elementas`	Sutvarkytas sąrašas
`> citata`	Blockquote
`---`	Horizontalus skirtukas

Dažni naudojimo atvejai

GitHub README: rašyti atvirojo kodo projekto dokumentaciją.
Techninė dokumentacija: rašyti vadovus, wiki arba dokumentacijos puslapius (MkDocs, Docusaurus, Hugo).
Tinklaraščio straipsniai: dauguma TVS (Jekyll, Ghost, Contentful) priima Markdown.
Komentarai ir problemos: GitHub, GitLab, Jira, Notion ir Slack visi palaiko GFM.
Suformatuoti el. laiškai: konvertuoti Markdown į HTML, kad būtų galima integruoti į HTML el. laišką.
Užrašai ir skaidrės: Obsidian, Notion, Marp ir Reveal.js naudoja Markdown.

Dažnai užduodami klausimai

Koks skirtumas tarp standartinio Markdown ir GFM?

Standartinis Markdown (CommonMark) apima pagrindinius elementus: antraštes, sąrašus, nuorodas, kodą. GFM (GitHub Flavored Markdown) prideda lenteles, užduočių sąrašus (- [ ] elementas), kalba apibrėžtą kodą (```php), paminėjimus ir automatines nuorodas. Šis įrankis naudoja GFM per biblioteką league/commonmark.

Ar sugeneruotas HTML yra saugus?

Taip. Konverteris sukonfigūruotas pašalinti neapdorotus HTML žymenis (html_input: strip) ir blokuoti nesaugias nuorodas, o tai užkerta kelią XSS atakoms. Sukurtas HTML tinka integruoti į esamą tinklalapį.

Ar galiu įterpti HTML į savo Markdown?

Saugumo sumetimais į Markdown įterptas neapdorotas HTML konvertavimo metu pašalinamas. Jei jums reikia pritaikyto HTML atvaizdavimo, rašykite tikslinį HTML tiesiogiai.

Koks yra didžiausias dokumento dydis?

Šiam įrankiui nėra griežto serverio pusės apribojimo. Labai ilgiems dokumentams (daugiau nei keli tūkstančiai eilučių) peržiūra realiuoju laiku gali sulėtėti, priklausomai nuo jūsų naršyklės.

Užklausos pavyzdys

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

Įvesties schema

Laukas	Tipas	Privalomas	Numatytasis
`input`	text		–

Galiniai taškai

GET https://cdrn.fr/api/v1/tools - išvardija visus galimus įrankius
GET https://cdrn.fr/api/v1/tools/markdown-formatter - gauna šio įrankio schemą
POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - vykdo šį įrankį su JSON payload