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.

74 lines
1.5 KiB

10 years ago
cooming soon
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.
10 years ago
__[Live demo](http://jonschlinkert.github.io/remarkable/demo/)__
10 years ago
10 years ago
Install
-------
node.js:
```bash
npm install remarkable --save
```
bower:
```bash
bower install remarkable --save
```
10 years ago
Usage
-----
```javascript
var Remarkable = require('remarkable');
var md = new Remarkable({
10 years ago
html: false, // enable html tags in source
xhtml: false, // use '/' to close single tags (<br />)
breaks: true, // convert '\n' in paragraphs into <br>
10 years ago
langPrefix: 'language-', // css language prefix for fenced blocks
10 years ago
// Should return HTML markup for highlighted text,
// or empty string to escape source
highlight: function (str, lang) { return ''; }
});
10 years ago
console.log(md.parse('# Remarkable rulezz!'));
//=> <h1># Remarkable rulezz!</h1>
```
You can define options via `set` method:
```javascript
var Remarkable = require('remarkable');
10 years ago
var md = new Remarkable();
md.set({
html: false,
10 years ago
breaks: true
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)
License
-------
[MIT](https://github.com/jonschlinkert/remarkable/blob/master/LICENSE)