Pārvērst un priekšskatīt Markdown

Vadības panelis
Dokumentācija
API

pārvērš jūsu Markdown HTML formātā un parāda tiešraides priekšskatījumu, ideāli piemērots README, dokumentācijas vai rakstu rakstīšanai

Kas ir Markdown?

Markdown ir viegla marķēšanas valoda, ko 2004. gadā izveidoja Džons Grūbers. Tā ļauj rakstīt formatētu tekstu, izmantojot vienkāršu un neapstrādātā veidā viegli lasāmu sintaksi, kas pēc tam tiek pārvērsta HTML formātā.

Šis rīks izmanto GFM (GitHub Flavored Markdown) specifikāciju, visizplatītāko variantu, kas pievieno atbalstu tabulām, izvēles rūtiņām, koda blokiem ar sintakses iezīmēšanu un automātiskām saitēm.

Priekšskatījums labajā pusē tiek atjaunināts reāllaikā rakstīšanas laikā. Poga Iesniegt ģenerē atbilstošo HTML kodu, kuru varat kopēt vai lejupielādēt.

Markdown pamatsintakse

Markdown	Rezultāts
`# Virsraksts 1`	Virsraksts <h1>
`## Virsraksts 2`	Virsraksts <h2>
`treknraksts`	treknraksts
`slīpraksts`	slīpraksts
`iekļautais kods`	`iekļautais kods`
```php ... ```	PHP koda bloks
`[teksts](url)`	Hipersaite
`![alt](url)`	Attēls
`- vienums`	Nesakārtots saraksts
`1. vienums`	Sakārtots saraksts
`> citāts`	Blockquote
`---`	Horizontāls atdalītājs

Bieži lietošanas gadījumi

GitHub README: rakstīt atvērtā koda projekta dokumentāciju.
Tehniskā dokumentācija: rakstīt rokasgrāmatas, wiki vai dokumentācijas lapas (MkDocs, Docusaurus, Hugo).
Emuāra raksti: lielākā daļa SVS (Jekyll, Ghost, Contentful) pieņem Markdown.
Komentāri un problēmas: GitHub, GitLab, Jira, Notion un Slack visi atbalsta GFM.
Formatēti e-pasti: pārvērst Markdown HTML formātā, lai integrētu HTML e-pastā.
Piezīmes un prezentācijas: Obsidian, Notion, Marp un Reveal.js izmanto Markdown.

Biežāk uzdotie jautājumi

Kāda ir atšķirība starp standarta Markdown un GFM?

Standarta Markdown (CommonMark) aptver pamatelementus: virsrakstus, sarakstus, saites, kodu. GFM (GitHub Flavored Markdown) pievieno tabulas, uzdevumu sarakstus (- [ ] vienums), ar valodu norobežotu kodu (```php), pieminējumus un automātiskās saites. Šis rīks izmanto GFM, izmantojot bibliotēku league/commonmark.

Vai ģenerētais HTML ir drošs?

Jā. Pārveidotājs ir konfigurēts, lai noņemtu neapstrādātos HTML tagus (html_input: strip) un bloķētu nedrošas saites, kas novērš XSS uzbrukumus. Iegūtais HTML ir piemērots integrēšanai esošā tīmekļa lapā.

Vai es varu iekļaut HTML savā Markdown?

Drošības apsvērumu dēļ Markdown ievietotais neapstrādātais HTML konvertēšanas laikā tiek noņemts. Ja jums nepieciešama pielāgota HTML renderēšana, rakstiet mērķa HTML tieši.

Kāds ir maksimālais dokumenta izmērs?

Šim rīkam servera pusē nav stingra ierobežojuma. Ļoti gariem dokumentiem (vairāk nekā daži tūkstoši rindu) priekšskatījums reāllaikā var palēnināties atkarībā no jūsu pārlūkprogrammas.

Pieprasījuma piemērs

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

Ievades shēma

Lauks	Tips	Obligāts	Noklusējums
`input`	text		–

Endpoint

GET https://cdrn.fr/api/v1/tools - uzskaita visus pieejamos rīkus
GET https://cdrn.fr/api/v1/tools/markdown-formatter - iegūst šī rīka shēmu
POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - izpilda šo rīku ar JSON payload