cooming soon

remarkable

Markdown parser done right. Fast and easy to extend.

Live demo

Install

node.js:

npm install remarkable --save

bower:

bower install remarkable --save

Usage

var Remarkable = require('remarkable');
var md = new Remarkable({
  html: false,              // enable html tags in source
  xhtml: false,             // use '/' to close single tags (<br />)
  breaks: true,             // convert '\n' in paragraphs into <br>
  langPrefix: 'language-',  // css language prefix for fenced blocks

  // Should return HTML markup for highlighted text,
  // or empty string to escape source
  highlight: function (str, lang) { return ''; }
});

console.log(md.parse('# Remarkable rulezz!'));
//=> <h1># Remarkable rulezz!</h1>

You can define options via set method:

var Remarkable = require('remarkable');
var md = new Remarkable();

md.set({
  html: false,
  breaks: true
});

Authors

• Jon Schlinkert github/jonschlinkert
• Alex Kocharin github/rlidwka
• Vitaly Puzrin github/puzrin

License

MIT