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 e52196d10e Demo update 10 years ago
benchmark Code structure and options refactoring 10 years ago
bin Code structure and options refactoring 10 years ago
demo Demo update 10 years ago
dist Demo update 10 years ago
lib Code structure and options refactoring 10 years ago
support Code structure and options refactoring 10 years ago
test Code structure and options refactoring 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 Code structure and options refactoring 10 years ago
index.js Renamed main class & file 10 years ago
package.json Added links autoconversion 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
  xhtmlOut:     false,        // Use '/' to close single tags (<br />)
  breaks:       false,        // Convert '\n' in paragraphs into <br>
  langPrefix:   'language-',  // CSS language prefix for fenced blocks
  linkify:      false,        // autoconvert url-like texts to links
  typographer:  false,        // Enable smartypants and other sweet transforms

  // Highlighter function. Should return escaped html,
  // or '' if input not changed
  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