Ikkonverti u ara l-anteprima tal-Markdown

Dashboard
Dokumentazzjoni
API

tikkonverti l-Markdown tiegħek f'HTML u turi anteprima f'ħin reali, ideali biex tikteb READMEs, dokumentazzjoni jew artikli

X'inhu Markdown?

Markdown hija lingwa ta' immarkar ħafifa maħluqa minn John Gruber fl-2004. Tippermetti li tikteb test ifformattjat billi tuża sintassi sempliċi u li tinqara faċilment fl-istat mhux ipproċessat, li mbagħad tiġi kkonvertita f'HTML.

Din l-għodda tuża l-ispeċifikazzjoni GFM (GitHub Flavored Markdown), il-varjant l-aktar mifrux, li jżid is-sapport għal tabelli, kaxxi tal-immarkar, blokki ta' kodiċi b'enfasi tas-sintassi u links awtomatiċi.

L-anteprima fuq il-lemin tiġi aġġornata f'ħin reali waqt li tittajpja. Il-buttuna Issottometti tiġġenera l-kodiċi HTML korrispondenti, li tista' tikkopja jew tniżżel.

Sintassi bażika ta' Markdown

Markdown	Riżultat
`# Titlu 1`	Titlu <h1>
`## Titlu 2`	Titlu <h2>
`grassett`	grassett
`korsiv`	korsiv
`kodiċi inline`	`kodiċi inline`
```php ... ```	Blokk ta' kodiċi PHP
`[test](url)`	Link ipertestwali
`![alt](url)`	Immaġni
`- element`	Lista mhux ordnata
`1. element`	Lista ordnata
`> kwotazzjoni`	Blockquote
`---`	Separatur orizzontali

Każijiet ta' użu komuni

README GitHub: kitba tad-dokumentazzjoni ta' proġett open source.
Dokumentazzjoni teknika: kitba ta' gwidi, wikis jew paġni ta' dokumentazzjoni (MkDocs, Docusaurus, Hugo).
Artikli tal-blog: il-biċċa l-kbira tas-CMS (Jekyll, Ghost, Contentful) jaċċettaw Markdown.
Kummenti u issues: GitHub, GitLab, Jira, Notion u Slack kollha jappoġġjaw GFM.
Emails ifformattjati: ikkonverti Markdown f'HTML biex tintegra f'email HTML.
Noti u slideshows: Obsidian, Notion, Marp u Reveal.js jużaw Markdown.

Mistoqsijiet frekwenti

X'inhi d-differenza bejn Markdown standard u GFM?

Il-Markdown standard (CommonMark) ikopri l-elementi bażiċi: titli, listi, links, kodiċi. GFM (GitHub Flavored Markdown) iżid it-tabelli, il-listi ta' kompiti (- [ ] element), il-kodiċi mdawwar bil-lingwa (```php), il-mentions u l-links awtomatiċi. Din l-għodda tuża GFM permezz tal-librerija league/commonmark.

Il-HTML iġġenerat huwa sigur?

Iva. Il-konvertitur huwa kkonfigurat biex ineħħi t-tags HTML mhux ipproċessati (html_input: strip) u biex jimblokka links mhux siguri, li jipprevjeni attakki XSS. Il-HTML prodott huwa adattat għall-integrazzjoni f'paġna web eżistenti.

Nista' ninkludi HTML fil-Markdown tiegħi?

Għal raġunijiet ta' sigurtà, il-HTML mhux ipproċessat imdaħħal fil-Markdown jitneħħa waqt il-konverżjoni. Jekk għandek bżonn rendering HTML personalizzat, ikteb il-HTML fil-mira direttament.

X'inhu d-daqs massimu tad-dokument?

Ma hemm l-ebda limitu strett min-naħa tas-server għal din l-għodda. Għal dokumenti twal ħafna (aktar minn ftit eluf ta' linji), l-anteprima f'ħin reali tista' tonqos fil-veloċità skont il-browser tiegħek.

Eżempju ta' talba

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

Skema ta' input

Kamp	Tip	Meħtieġ	Default
`input`	text		–

Endpoints

GET https://cdrn.fr/api/v1/tools - telenka l-għodod kollha disponibbli
GET https://cdrn.fr/api/v1/tools/markdown-formatter - tikseb l-iskema ta' din l-għodda
POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - teżegwixxi din l-għodda b'payload JSON