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 47432ce76e Updated renderer signatures (pass env) 10 years ago
benchmark Renamed stmd -> commonmark 10 years ago
bin Freeze default rules set (~ equal to GFM). Added `full` preset to enable everything. 10 years ago
demo Docs update 10 years ago
dist Browser files rebuild 10 years ago
lib Updated renderer signatures (pass env) 10 years ago
support Renamed stmd -> commonmark 10 years ago
test Fixed replaceEntities, default preset, improved coverage 10 years ago
.editorconfig Fix .editorconfig 10 years ago
.eslintignore Added coverage reports generation, related to #66 10 years ago
.eslintrc updated eslint to 9.1 & did appropriate changes in sources 10 years ago
.gitignore Added coverage reports generation, related to #66 10 years ago
.nojekyll Updated `make gh-pages` 10 years ago
.npmignore Added coverage reports generation, related to #66 10 years ago
.travis.yml Added coverall.io integration 10 years ago
CHANGELOG.md Updated parsers API - don't rewrite token arrays in StateCore 10 years ago
CONTRIBUTING.md + commit to dev 10 years ago
LICENSE Added demo stub and updated docs 10 years ago
Makefile Coverage improve 10 years ago
README.md docs update 10 years ago
bower.json Added coverage reports generation, related to #66 10 years ago
index.js Renamed main class & file 10 years ago
package.json 1.3.0 released 10 years ago

README.md

remarkable

Build Status NPM version Coverage Status

Markdown parser done right. Fast and easy to extend.

Live demo

Install

node.js:

npm install remarkable --save

bower:

bower install remarkable --save

browser (CDN):

Usage

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

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

Options

By default remarkable is configured to be similar to GFM, but with HTML disabled. This is easy to change if you prefer to use different settings.

There are two ways to define options.

constructor

Define options in the constructor:

// Actual default values
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 text to links

  // Enable some language-neutral replacement + quotes beautification
  typographer:  false,

  // Double + single quotes replacement pairs, when typographer enabled,
  // and smartquotes on. Set doubles to '«»' for Russian, '„“' for German.
  quotes: '“”‘’',

  // Highlighter function. Should return escaped HTML,
  // or '' if the source string is not changed
  highlight: function (/*str, lang*/) { return ''; }
});

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

.set

Or define options via the .set() method:

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

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

Note: To achieve the best possible performance, don't modify a Remarkable instance on the fly. If you need multiple configurations it's best to create multiple instances and initialize each with a configuration that is ideal for that instance.

Presets

Remarkable offers some "presets" as a convenience to quickly enable/disable active syntax rules and options for common use cases.

commonmark

Enable strict CommonMark mode with the commonmark preset:

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

full

Enable all available rules (but still with default options, if not set):

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

// Or with options:
var md = new Remarkable('full', {
  html: true,
  linkify: true,
  typographer: true
});

Syntax highlighting

Apply syntax highlighting to fenced code blocks with the highlight option:

var Remarkable = require('remarkable');
var hljs       = require('highlight.js') // https://highlightjs.org/

// Actual default values
var md = new Remarkable({
  highlight: function (str, lang) {
    if (lang && hljs.getLanguage(lang)) {
      try {
        return hljs.highlight(lang, str).value;
      } catch (err) {}
    }

    try {
      return hljs.highlightAuto(str).value;
    } catch (err) {}

    return ''; // use external default escaping
  }
});

Syntax extensions

Enabled by default:

  • Tables (GFM)
  • <del> (GFM strikethrough) - ~~deleted text~~

Disabled by default:

  • <sup> - 19^th^
  • <sub> - H~2~0
  • abbreviations
  • <ins> - ++inserted text++ (experimental)
  • <mark> - ==marked text== (experimental)

* Experimental extensions can be changed later for something like Critic Markup, but you will still be able to use old-style rules via external plugins if you prefer.

Manage rules

var md = new Remarkable();
md.inline.ruler.enable([ 'ins', 'mark' ]);
md.block.ruler.disable([ 'table' ]);

// Enable everything
md = new Remarkable('full', {
  html: true,
  linkify: true,
  typographer: true,
});

Typographer

Although full-weight typographical replacements are language specific, remarkable provides coverage for the most common and universal use cases:

var Remarkable = require('remarkable');
var md = new Remarkable({
  typographer: true,
  quotes: '“”‘’'
});

// Disable rules at all:
md.core.ruler.disable([ 'replacements', 'smartquotes' ]);

// Actual default replacements:
//
// '' → ‘’
// "" → “”. Set '«»' for Russian, '„“' for German, empty to disable
// (c) (C) → ©
// (tm) (TM) → ™
// (r) (R) → ®
// +- → ±
// (p) (P) -> §
// ... → … (also ?.... → ?.., !.... → !..)
// ???????? → ???, !!!!! → !!!, `,,` → `,`
// -- → &ndash;, --- → &mdash;
//

Of course, you can also add your own rules or replace the defaults with something more advanced or specific to your language.

Plugins

Easily load plugins with the .use() method:

var md = new Remarkable();

md.use(plugin1)
  .use(plugin2, opts)
  .use(plugin3);

References / Thanks

Big thanks to John MacFarlane for his work on the CommonMark spec and reference implementations. His work saved us a lot of time during this project's development.

Related Links:

  1. https://github.com/jgm/CommonMark - reference CommonMark implementations in C & JS, also contains latest spec & online demo.
  2. http://talk.commonmark.org - CommonMark forum, good place to collaborate developers' efforts.

Development / Modification

Parser consists of several responsibilities chains, filled with rules. You can reconfigure anyone as you wish. Render also can be modified and extended. See source code to understand details. Pay attention to these properties:

Remarkable.core
Remarkable.core.ruler
Remarkable.block
Remarkable.block.ruler
Remarkable.inline
Remarkable.inline.ruler
Remarkable.renderer
Remarkable.renderer.rules

Benchmark

Here is result of CommonMark spec parse at Core i5 2.4 GHz (i5-4258U):

$ benchmark/benchmark.js spec
Selected samples: (1 of 27)
 > spec

Sample: spec.txt (110610 bytes)
 > commonmark-reference x 40.42 ops/sec ±4.07% (51 runs sampled)
 > current x 74.99 ops/sec ±4.69% (67 runs sampled)
 > current-commonmark x 93.76 ops/sec ±1.23% (79 runs sampled)
 > marked-0.3.2 x 22.92 ops/sec ±0.79% (41 runs sampled)

As you can see, remarkabe doesn't pay with speed for it's flexibility. Because it's written in monomorphyc style and use JIT inline caches effectively.

Authors

License

MIT