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.

306 lines
7.7 KiB

# remarkable
10 years ago
[![Build Status](https://travis-ci.org/jonschlinkert/remarkable.svg?branch=master)](https://travis-ci.org/jonschlinkert/remarkable)
[![NPM version](https://img.shields.io/npm/v/remarkable.svg)](https://www.npmjs.org/package/remarkable)
[![Coverage Status](https://img.shields.io/coveralls/jonschlinkert/remarkable.svg)](https://coveralls.io/r/jonschlinkert/remarkable?branch=dev)
10 years ago
> Markdown parser done right. Fast and easy to extend.
10 years ago
__[Live demo](http://jonschlinkert.github.io/remarkable/demo/)__
- Supports the [CommonMark](http://commonmark.org/) spec +
[syntax extensions](#syntax-extensions) + sugar (URL autolinking, typographer).
10 years ago
- Configurable syntax! You can add new rules and even replace existing ones.
- [High speed](#benchmark)!
10 years ago
10 years ago
## Install
10 years ago
**node.js:**
10 years ago
```bash
npm install remarkable --save
```
**bower:**
10 years ago
```bash
bower install remarkable --save
```
**browser (CDN):**
- [jsDeliver CDN](http://www.jsdelivr.com/#!remarkable "jsDelivr CDN")
10 years ago
## Usage
10 years ago
```js
var Remarkable = require('remarkable');
var md = new Remarkable();
console.log(md.render('# Remarkable rulezz!'));
// => <h1>Remarkable rulezz!</h1>
```
### Options
10 years ago
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:
```js
// 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
10 years ago
// 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 ''; }
});
10 years ago
console.log(md.render('# Remarkable rulezz!'));
// => <h1>Remarkable rulezz!</h1>
10 years ago
```
#### .set
Or define options via the `.set()` method:
10 years ago
```js
var Remarkable = require('remarkable');
var md = new Remarkable();
10 years ago
md.set({
10 years ago
html: true,
10 years ago
breaks: true
10 years ago
});
```
10 years ago
**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.
10 years ago
### Presets
10 years ago
Remarkable offers some "presets" as a convenience to quickly enable/disable
active syntax rules and options for common use cases.
#### commonmark
Enable strict [CommonMark](http://commonmark.org/) mode with the `commonmark` preset:
10 years ago
```js
10 years ago
var Remarkable = require('remarkable');
var md = new Remarkable('commonmark');
```
#### full
10 years ago
Enable all available rules (but still with default options, if not set):
10 years ago
```js
var Remarkable = require('remarkable');
var md = new Remarkable('full');
10 years ago
// Or with options:
var md = new Remarkable('full', {
html: true,
linkify: true,
typographer: true
});
10 years ago
```
### Syntax highlighting
10 years ago
Apply syntax highlighting to fenced code blocks with the `highlight` option:
```js
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
}
});
```
10 years ago
### Syntax extensions
10 years ago
Enabled by default:
- [Tables](https://help.github.com/articles/github-flavored-markdown/#tables) (GFM)
10 years ago
- [\<del>](https://help.github.com/articles/github-flavored-markdown/#strikethrough)
(GFM strikethrough) - `~~deleted text~~`
10 years ago
Disabled by default:
- [\<sup>](http://johnmacfarlane.net/pandoc/README.html#superscripts-and-subscripts) - `19^th^`
10 years ago
- [\<sub>](http://johnmacfarlane.net/pandoc/README.html#superscripts-and-subscripts) - `H~2~0`
10 years ago
- [abbreviations](https://michelf.ca/projects/php-markdown/extra/#abbr)
- __\<ins>__ - `++inserted text++` (experimental)
- __\<mark>__ - `==marked text==` (experimental)
__*__ Experimental extensions can be changed later for something like
10 years ago
[Critic Markup](http://criticmarkup.com/), but you will still be able to use
old-style rules via external plugins if you prefer.
10 years ago
### Manage rules
10 years ago
```js
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,
});
```
10 years ago
### Typographer
10 years ago
Although full-weight typographical replacements are language specific, `remarkable`
provides coverage for the most common and universal use cases:
10 years ago
```js
10 years ago
var Remarkable = require('remarkable');
10 years ago
var md = new Remarkable({
typographer: true,
quotes: '“”‘’'
});
10 years ago
10 years ago
// 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;
//
10 years ago
```
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:
```js
var md = new Remarkable();
md.use(plugin1)
.use(plugin2, opts)
.use(plugin3);
```
10 years ago
## References / Thanks
10 years ago
Big thanks to [John MacFarlane](https://github.com/jgm) for his work on the
10 years ago
CommonMark spec and reference implementations. His work saved us a lot of time
10 years ago
during this project's development.
10 years ago
**Related Links:**
10 years ago
1. https://github.com/jgm/CommonMark - reference CommonMark implementations in C & JS,
10 years ago
also contains latest spec & online demo.
2. http://talk.commonmark.org - CommonMark forum, good place to collaborate
developers' efforts.
10 years ago
## 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:
10 years ago
```js
10 years ago
Remarkable.core
Remarkable.core.ruler
10 years ago
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):
```bash
$ 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.
10 years ago
## Authors
- Jon Schlinkert [github/jonschlinkert](https://github.com/jonschlinkert)
- Alex Kocharin [github/rlidwka](https://github.com/rlidwka)
- Vitaly Puzrin [github/puzrin](https://github.com/puzrin)
10 years ago
## License
10 years ago
[MIT](https://github.com/jonschlinkert/remarkable/blob/master/LICENSE)