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.

194 lines
5.2 KiB

10 years ago
remarkable
==========
[![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)
Markdown parser done right. Fast and easy to extend.
__[Live demo](http://jonschlinkert.github.io/remarkable/demo/)__
10 years ago
- Configurable syntax! You can add new rules and even replace existing ones.
- Implements [CommonMark](http://commonmark.org/) spec + extentions
(strikethrough, tables, URL autolinking, typographer).
10 years ago
- Very high speed.
10 years ago
## Install
10 years ago
node.js:
```bash
npm install remarkable --save
```
bower:
```bash
bower install remarkable --save
```
CDNs for browser: [jsDeliver](http://www.jsdelivr.com/#!remarkable "jsDelivr CDN")
10 years ago
## Usage
10 years ago
```js
var Remarkable = require('remarkable');
// This values are default
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
10 years ago
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 ''; }
});
10 years ago
console.log(md.render('# Remarkable rulezz!'));
// => <h1>Remarkable rulezz!</h1>
10 years ago
```
You can define options via `set` method:
```js
var Remarkable = require('remarkable');
10 years ago
var md = new Remarkable();
md.set({
html: false,
10 years ago
breaks: true
10 years ago
});
```
10 years ago
__Note.__ To acheive best performance, don't modify the `Remarkable` instance on
10 years ago
the fly. If you need several configurations - create multiple instances and
10 years ago
initialise each appropriately.
10 years ago
You can also reset parser to strict [CommonMark](http://commonmark.org/) mode:
```js
10 years ago
var Remarkable = require('remarkable');
var md = new Remarkable('commonmark');
```
### Highligh fenced blocks
To highlight content of fenced block, assing function to `highlight` option:
```js
var Remarkable = require('remarkable');
var hljs = require('highlight.js') // https://highlightjs.org/
10 years ago
// These values are default
var md = new Remarkable({
highlight: function (str, lang) {
if (lang && hljs.getLanguage(lang)) {
try {
return hljs.highlight(lang, str).value;
} catch (__) {}
}
try {
return hljs.highlightAuto(str).value;
} catch (__) {}
return ''; // use external default escaping
}
});
```
10 years ago
### Typographer
10 years ago
10 years ago
Though full-weight typograpic replacements are language specific, `remarkable`
10 years ago
provides the most common and universal case coverage:
```js
10 years ago
var Remarkable = require('remarkable');
var md = new Remarkable({ typographer: true });
10 years ago
// These values are default
10 years ago
md.typographer.set({
10 years ago
singleQuotes: '‘’', // set empty to disable
doubleQuotes: '“”', // set '«»' for russian, '„“' for deutch, empty to disable
10 years ago
copyright: true, // (c) (C) → ©
trademark: true, // (tm) (TM) → ™
registered: true, // (r) (R) → ®
plusminus: true, // +- → ±
10 years ago
paragraph: true, // (p) (P) -> §
ellipsis: true, // ... → … (also ?.... → ?.., !.... → !..)
10 years ago
dupes: true, // ???????? → ???, !!!!! → !!!, `,,``,`
10 years ago
dashes: true // -- → &ndash;, --- → &mdash;
10 years ago
})
```
10 years ago
Of course, you can add your own rules or replace default ones with something
more advanced, specific for your language.
### More extras
10 years ago
These extensions are enabled by default:
- [Strikethrough](https://help.github.com/articles/github-flavored-markdown/#strikethrough)
10 years ago
- [Tables](https://help.github.com/articles/github-flavored-markdown/#tables) (GFM)
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
Links:
1. https://github.com/jgm/stmd - reference CommonMark implementations in C & JS,
also contains latest spec & online demo.
2. http://talk.commonmark.org - CommonMark forum, good place to collaborate
developpers 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 this properties:
```js
10 years ago
Remarkable.block
Remarkable.block.ruler
Remarkable.inline
Remarkable.inline.ruler
Remarkable.typographer
Remarkable.typographer.ruler
Remarkable.linkifier
Remarkable.linkifier.ruler
Remarkable.renderer
Remarkable.renderer.rules
```
10 years ago
To prettify plugins init, `Remarked` has `.use()` helper for curried calls:
```js
var md = new Remarkable();
md.use(plugin1)
.use(plugin2, opts)
.use(plugin3);
```
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)