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 4e4a43a0a5 Started adding remarkable-specific tests 10 years ago
benchmark Options rename 10 years ago
bin Added typographer draft 10 years ago
demo demo rebuild 10 years ago
dist demo rebuild 10 years ago
lib Added typographer draft 10 years ago
support Options rename 10 years ago
test Started adding remarkable-specific tests 10 years ago
.editorconfig Fix .editorconfig 10 years ago
.eslintignore Refactored demo build scripts 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 Demo: updated css & browser js files 10 years ago
README.md Options rename 10 years ago
index.js Renamed main class & file 10 years ago
package.json Demo: permalink, autoprefixer 10 years ago

README.md

cooming soon

remarkable

Build Status NPM version

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

License

MIT