Markdown átalakítása és előnézete

Irányítópult
Dokumentáció
API

átalakítja Markdownját HTML-lé és élő előnézetet jelenít meg, ideális README-fájlok, dokumentációk vagy cikkek írásához

Mi az a Markdown?

A Markdown egy könnyűsúlyú jelölőnyelv, amelyet John Gruber hozott létre 2004-ben. Lehetővé teszi formázott szöveg írását egyszerű, nyers állapotában is olvasható szintaxissal, amely azután HTML-lé alakul.

Ez az eszköz a GFM (GitHub Flavored Markdown) specifikációt használja, a legelterjedtebb változatot, amely támogatást ad a táblázatokhoz, a jelölőnégyzetekhez, a szintaxiskiemeléses kódblokkokhoz és az automatikus linkekhez.

A jobb oldali előnézet valós időben frissül gépelés közben. A Küldés gomb létrehozza a megfelelő HTML-kódot, amelyet kimásolhat vagy letölthet.

Alapvető Markdown szintaxis

Markdown	Megjelenítés
`# Cím 1`	Cím <h1>
`## Cím 2`	Cím <h2>
`félkövér`	félkövér
`dőlt`	dőlt
`soron belüli kód`	`soron belüli kód`
```php ... ```	PHP kódblokk
`[szöveg](url)`	Hiperhivatkozás
`![alt](url)`	Kép
`- elem`	Rendezetlen lista
`1. elem`	Rendezett lista
`> idézet`	Blockquote
`---`	Vízszintes elválasztó

Gyakori felhasználási esetek

GitHub README: nyílt forráskódú projekt dokumentációjának megírása.
Műszaki dokumentáció: útmutatók, wikik vagy dokumentációs oldalak írása (MkDocs, Docusaurus, Hugo).
Blogcikkek: a legtöbb CMS-rendszer (Jekyll, Ghost, Contentful) elfogadja a Markdownt.
Hozzászólások és hibajegyek: a GitHub, GitLab, Jira, Notion és Slack mind támogatja a GFM-et.
Formázott e-mailek: Markdown HTML-lé alakítása HTML e-mailbe ágyazáshoz.
Jegyzetek és diavetítések: az Obsidian, Notion, Marp és Reveal.js Markdownt használ.

Gyakran ismételt kérdések

Mi a különbség a szabványos Markdown és a GFM között?

A szabványos Markdown (CommonMark) az alapvető elemeket fedi le: címek, listák, linkek, kód. A GFM (GitHub Flavored Markdown) hozzáadja a táblázatokat, a feladatlistákat (- [ ] elem), a nyelvvel lezárt kódot (```php), az említéseket és az automatikus linkeket. Ez az eszköz a GFM-et a league/commonmark könyvtáron keresztül használja.

Biztonságos a generált HTML?

Igen. Az átalakító úgy van beállítva, hogy eltávolítsa a nyers HTML-címkéket (html_input: strip) és blokkolja a nem biztonságos linkeket, ami megakadályozza az XSS-támadásokat. Az előállított HTML alkalmas egy meglévő weboldalba való beágyazásra.

Beilleszthetek HTML-t a Markdownomba?

Biztonsági okokból a Markdownba beillesztett nyers HTML az átalakítás során eltávolításra kerül. Ha egyéni HTML-megjelenítésre van szüksége, írja meg közvetlenül a cél HTML-t.

Mekkora a dokumentum maximális mérete?

Ehhez az eszközhöz nincs szigorú korlát a kiszolgáló oldalán. Nagyon hosszú dokumentumok esetén (néhány ezer sornál több) a valós idejű előnézet a böngészőtől függően lelassulhat.

Kérés példa

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

Bemeneti séma

Mező	Típus	Kötelező	Alapértelmezett
`input`	text		–

Végpontok

GET https://cdrn.fr/api/v1/tools - listázza az összes elérhető eszközt
GET https://cdrn.fr/api/v1/tools/markdown-formatter - lekéri ezen eszköz sémáját
POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - végrehajtja ezen eszközt JSON payloaddal