Tiontaigh agus déan réamhamharc ar Markdown

Deais
Doiciméadú
API

tiontaíonn sé do chuid Markdown go HTML agus taispeánann sé réamhamharc beo, foirfe chun READMEanna, doiciméadúchán nó ailt a scríobh

Cad é Markdown?

Is teanga mharcála éadrom é Markdown a chruthaigh John Gruber in 2004. Ligeann sé duit téacs formáidithe a scríobh trí chomhréir shimplí atá inléite ina staid amh, a thiontaítear ansin go HTML.

Úsáideann an uirlis seo an tsonraíocht GFM (GitHub Flavored Markdown), an leagan is forleithne, a chuireann tacaíocht le táblaí, le boscaí ticeála, le bloic chóid le dathú comhréire agus le naisc uathoibríocha.

Nuashonraítear an réamhamharc ar dheis i bhfíor-am agus tú ag clóscríobh. Gineann an cnaipe Cuir isteach an cód HTML comhfhreagrach, ar féidir leat é a chóipeáil nó a íoslódáil.

Bunchomhréir Markdown

Markdown	Rindreáil
`# Teideal 1`	Teideal <h1>
`## Teideal 2`	Teideal <h2>
`trom`	trom
`iodálach`	iodálach
`cód inlíne`	`cód inlíne`
```php ... ```	Bloc cóid PHP
`[téacs](url)`	Hipearnasc
`![alt](url)`	Íomhá
`- mír`	Liosta neamhordaithe
`1. mír`	Liosta ordaithe
`> athfhriotal`	Blockquote
`---`	Deighilteoir cothrománach

Cásanna úsáide coitianta

README GitHub: doiciméadúchán tionscadail foinse oscailte a scríobh.
Doiciméadúchán teicniúil: treoracha, vicíonna nó leathanaigh doic a scríobh (MkDocs, Docusaurus, Hugo).
Ailt bhlag: glacann formhór na gcóras CMS (Jekyll, Ghost, Contentful) le Markdown.
Tuairimí agus saincheisteanna: tacaíonn GitHub, GitLab, Jira, Notion agus Slack go léir le GFM.
Ríomhphoist fhormáidithe: Markdown a thiontú go HTML lena leabú i ríomhphost HTML.
Nótaí agus sleamhnáin: úsáideann Obsidian, Notion, Marp agus Reveal.js Markdown.

Ceisteanna coitianta

Cad é an difríocht idir Markdown caighdeánach agus GFM?

Clúdaíonn Markdown caighdeánach (CommonMark) na buneilimintí: teidil, liostaí, naisc, cód. Cuireann GFM (GitHub Flavored Markdown) táblaí, liostaí tascanna (- [ ] mír), cód iata le teanga (```php), luanna agus naisc uathoibríocha leis. Úsáideann an uirlis seo GFM tríd an leabharlann league/commonmark.

An bhfuil an HTML a gineadh slán?

Tá. Tá an tiontaire cumraithe chun clibeanna HTML amha a bhaint (html_input: strip) agus chun naisc neamhshlána a chosc, rud a chuireann cosc ar ionsaithe XSS. Tá an HTML a tháirgtear oiriúnach lena leabú i leathanach gréasáin atá ann cheana.

An féidir liom HTML a chur i mo chuid Markdown?

Ar mhaithe le slándáil, baintear an HTML amh a chuirtear isteach sa Markdown le linn an tiontaithe. Má tá rindreáil HTML shaincheaptha uait, scríobh an HTML sprice go díreach.

Cad é uasmhéid an doiciméid?

Níl aon teorainn dhocht ar thaobh an fhreastalaí don uirlis seo. I gcás doiciméad an-fhada (níos mó ná cúpla míle líne), d'fhéadfadh an réamhamharc fíor-ama moilliú ag brath ar do bhrabhsálaí.

Sampla iarratais

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

Scéimre ionchuir

Réimse	Cineál	Riachtanach	Réamhshocrú
`input`	text		–

Críochphointí

GET https://cdrn.fr/api/v1/tools - liostaíonn na huirlisí go léir atá ar fáil
GET https://cdrn.fr/api/v1/tools/markdown-formatter - faigh scéimre na huirlise seo
POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - rith an uirlis seo le pálasta JSON