Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed https://markdown-it.github.io/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Vitaly Puzrin f13f984335 Added `breaks` option, on by default 10 years ago
benchmark Added stmd to benchmark 10 years ago
bin API & options names polish 10 years ago
demo Added demo stub and updated docs 10 years ago
dist Added demo stub and updated docs 10 years ago
lib Added `breaks` option, on by default 10 years ago
test Added `breaks` option, on by default 10 years ago
.editorconfig Fix .editorconfig 10 years ago
.eslintignore replaced jshint with eslint for better style check 10 years ago
.eslintrc Inline lexer draft 10 years ago
.gitignore First commit 10 years ago
.nojekyll Updated `make gh-pages` 10 years ago
.npmignore First commit 10 years ago
.travis.yml First commit 10 years ago
CHANGELOG.md Added demo stub and updated docs 10 years ago
LICENSE Added demo stub and updated docs 10 years ago
Makefile Replaced old stmd tests with fresh specs 10 years ago
README.md Added `breaks` option, on by default 10 years ago
index.js Splitted block lexer & index to files 10 years ago
package.json Frozen eslint version to fix warnings 10 years ago

README.md

cooming soon

remarkable

Build Status NPM version

Markdown parser done right. Fast and easy to extend.

Live demo

/INTRO/

Install

node.js:

npm install remarkable --save

bower:

bower install remarkable --save

Usage

var Remarkable = require('remarkable')();
var md = new Remarkable({
  html: false,
  xhtml: false,
  breaks: true,
  langprefix: 'language-'
});

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,
  xhtml: false,
  breaks: true,
  langprefix: 'language-'
});

Authors

License

MIT