Markdowni teisendamine ja eelvaade

Töölaud
Dokumentatsioon
API

teisendab teie Markdowni HTML-iks ja kuvab reaalajas eelvaate, ideaalne READMEde, dokumentatsiooni või artiklite kirjutamiseks

Mis on Markdown?

Markdown on kergekaaluline märgistuskeel, mille lõi John Gruber 2004. aastal. See võimaldab kirjutada vormindatud teksti lihtsa süntaksi abil, mis on loetav ka töötlemata kujul, ning seejärel teisendatakse see HTML-iks.

See tööriist kasutab spetsifikatsiooni GFM (GitHub Flavored Markdown), kõige levinumat varianti, mis lisab toe tabelitele, märkeruutudele, süntaksi esiletõstmisega koodiplokkidele ja automaatsetele linkidele.

Paremal asuv eelvaade uueneb reaalajas, kui te kirjutate. Nupp Esita genereerib vastava HTML-koodi, mille saate kopeerida või alla laadida.

Markdowni põhisüntaks

Markdown	Tulemus
`# Pealkiri 1`	<h1> pealkiri
`## Pealkiri 2`	<h2> pealkiri
`paks`	paks
`kaldkiri`	kaldkiri
`reasisene kood`	`reasisene kood`
```php ... ```	PHP koodiplokk
`[tekst](url)`	Hüperlink
`![alt](url)`	Pilt
`- element`	Järjestamata loend
`1. element`	Järjestatud loend
`> tsitaat`	Blockquote
`---`	Horisontaalne eraldaja

Levinud kasutusjuhud

GitHubi README: avatud lähtekoodiga projekti dokumentatsiooni kirjutamine.
Tehniline dokumentatsioon: juhendite, wikide või dokumentatsioonilehtede kirjutamine (MkDocs, Docusaurus, Hugo).
Blogiartiklid: enamik CMS-e (Jekyll, Ghost, Contentful) aktsepteerivad Markdowni.
Kommentaarid ja probleemid: GitHub, GitLab, Jira, Notion ja Slack toetavad kõik GFM-i.
Vormindatud e-kirjad: Markdowni teisendamine HTML-iks, et see HTML-e-kirja integreerida.
Märkmed ja esitlused: Obsidian, Notion, Marp ja Reveal.js kasutavad Markdowni.

Korduma kippuvad küsimused

Mis vahe on tavalisel Markdownil ja GFM-il?

Tavaline Markdown (CommonMark) hõlmab põhielemente: pealkirju, loendeid, linke, koodi. GFM (GitHub Flavored Markdown) lisab tabelid, ülesandeloendid (- [ ] element), keelega piiritletud koodi (```php), mainimised ja automaatsed lingid. See tööriist kasutab GFM-i teegi league/commonmark kaudu.

Kas genereeritud HTML on turvaline?

Jah. Teisendaja on seadistatud eemaldama töötlemata HTML-märgendid (html_input: strip) ja blokeerima ebaturvalised lingid, mis hoiab ära XSS-rünnakud. Loodud HTML sobib integreerimiseks olemasolevasse veebilehte.

Kas ma saan oma Markdowni lisada HTML-i?

Turvalisuse huvides eemaldatakse Markdowni sisestatud töötlemata HTML teisendamise käigus. Kui vajate kohandatud HTML-renderdust, kirjutage soovitud HTML otse.

Mis on dokumendi maksimaalne suurus?

Selle tööriista jaoks ei ole serveripoolset ranget piirangut. Väga pikkade dokumentide puhul (rohkem kui paar tuhat rida) võib reaalajas eelvaade sõltuvalt teie brauserist aeglustuda.

Päringunäide

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

Sisendskeem

Väli	Tüüp	Kohustuslik	Vaikimisi
`input`	text		–

Lõpp-punktid

GET https://cdrn.fr/api/v1/tools - loetleb kõik saadaolevad tööriistad
GET https://cdrn.fr/api/v1/tools/markdown-formatter - toob selle tööriista skeemi
POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - täidab selle tööriista JSON-payloadiga