Mis on Markdown?

Markdown on kerge märgistuskeel, mis kasutab teksti vormindamiseks lihtsaid sümboleid. Märgid nagu # pealkirjade jaoks, ** paksus kirjas teksti jaoks, * kaldkirja jaoks ning - või * loendite jaoks võimaldavad kirjutada struktureeritud dokumente ilma visuaalse redaktorita. Seda kasutatakse laialdaselt README-failides, dokumentatsioonis, märkmete tegemise rakendustes, blogides ja arendusplatvormidel nagu GitHub.

Kuigi Markdown on oma lähtevormi kujul lihtne lugeda, on olukordi, kus on vaja lihtteksti sisu ilma igasuguse vormindussüntaksita. Markdowni käsitsi eemaldamine on tüütu, eriti keerukate dokumentide puhul, mis sisaldavad pesastatud loendeid, blokktsitaate, tabeleid ja reasisest koodi.

Tööriista kirjeldus

See tööriist teisendab Markdowni puhtaks lihttekstiks, eemaldades vormindussüntaksi, säilitades samal ajal dokumendi struktuurielemendid. Erinevalt lihtsast lähenemisest „eemalda kõik erimärgid", säilitab see intelligentselt loendimärgid (-, *, +), järjestatud loendite numbrid, blokktsitaadi indikaatorid (>), horisontaalsed jooned (---) ja tabelipaigutused. Tulemuseks on loetav, hästi struktureeritud lihttekst, mis säilitab algse dokumendi ülesehituse ilma Markdowni-spetsiifilise süntaksita.

Näited

Sisend (Markdown):

# Project Overview

This is a **bold** statement with *italic* emphasis and a [link](https://example.com).

- First item
- Second item
- Third item

> Important note with **emphasis**

1. Step one
2. Step two

Väljund (lihttekst):

Project Overview

This is a bold statement with italic emphasis and a link.

- First item
- Second item
- Third item

> Important note with emphasis

1. Step one
2. Step two

Funktsioonid

  • Eemaldab reasisese vorminduse — Eemaldab paksus kirjas, kaldkirjas, läbikriipsutatud teksti, reasisese koodi tagakriipsud ning lingi/pildi süntaksi, säilitades nähtava teksti
  • Säilitab loendimärgid — Hoiab alles -, *, + järjestamata loendite jaoks ning numbrid järjestatud loendite jaoks
  • Säilitab blokktsitaadid — Hoiab alles > eesliited, et tsiteeritud lõigud jääksid visuaalselt eristatavaks
  • Käsitleb tabeleid — Teisendab Markdowni tabelid toruoperaatoriga eraldatud lihtteksti ridadeks
  • Eemaldab HTML-sildid — Kõik Markdowni sisse põimitud reasisesed HTML-elemendid eemaldatakse väljundist

Kasutusjuhud

  • Sisu kopeerimine e-kirjadesse — Eraldage puhas tekst Markdowni dokumentidest, et kleepida see e-posti klientidesse, mis ei toeta Markdowni renderdamist
  • Teksti ettevalmistamine mittetehnilistele kasutajatele — Eemaldage vormindussüntaks enne sisu jagamist inimestega, kes ei tunne Markdowni
  • Andmete eraldamine — Hankige loetav tekst Markdowni-põhisest dokumentatsioonist või README-failidest indekseerimiseks, otsimiseks või edasiseks töötlemiseks

Kuidas see töötab

Tööriist parsib Markdowni sisendi abstraktseks süntaksipuuks (AST), kasutades standarditele vastavat Markdowni parserit. Seejärel läbib see iga puu sõlme — pealkirjad, lõigud, loendid, blokktsitaadid, koodiplokid, tabelid ja reasisesed elemendid — ning rekonstrueerib tekstisisu ilma vormindusmarkideta. Reasisesed elemendid nagu paksus kirjas tekst, kaldkiri, lingid ja pildid taandatakse nende nähtavale tekstile. Struktuurimärgid nagu loendipunktid, nummerdatud eesliited ja blokktsitaadi indikaatorid säilitatakse loetavuse tagamiseks.

Mis eemaldatakse ja mis säilitatakse

Eemaldatakse Säilitatakse
# pealkirjamärgid Pealkirja tekst
**paks** / *kaldkiri* Paksus/kaldkirjas tekst
[link](url) süntaks Lingi tekst
`reasisene kood` Koodi sisu
Koodiploki piirdemärgid Koodiploki sisu
![pilt](url) süntaks Alternatiivtekst
HTML-sildid
Loendimärgid (- * +)
Järjestatud loendi numbrid
Blokktsitaadi > märgid
Horisontaalsed jooned ---
Tabelistruktuur