neljapäev, 2. september 2010

node-markdown

Vormistasin väga hea Showdown skripti Node.JS mooduliks nimega node-markdown. Tegu on siis Markdown süntaksi konverteerijaga, mis teeb Markdown tekstist HTML koodi. Installida saab mooduli npm kaudu käsuga npm install node-markdown.

Kasutamine on lihtne - tuleb laadida konverteerimisfunktsioon ja seda saabki seejärel otse kasutada.

var md = require("node-markdown").Markdown,
    html = md(markdown_text);


Täpsemalt võib lugeda mooduli lehelt.

Miks üldse Markdowni kasutada?

Tegu on "naturaalse" süntaksiga, mis on eeskuju võtnud tekstilise e-posti vormistamisest. Idee seisneb selles, et ka töötlemata tekst peaks olema silmale arusaadav ning ei paistaks otseselt kodeeringuna välja.

Näiteks

See on pealkiri
-------------------

Siin tuleb mummudega nimekiri:

  * Nimekirja element nr 1
  * Nimekirja element nr 2
  * Nimekirja element nr 3


Näeb ju arusaadav välja. Kodeerijast läbi lastes muutuks "See on pealkiri"
<H2> elemendiks, "Siia tuleb mummudega nimekiri" <P> paragrafiks ja tärnidega read <UL> nimekirjaks.

Kommentaare ei ole: