remarked
Markdown parser and lexer. A fork of marked.js maintained for Assemble.
Install
npm
npm i remarked --save
Why?
Usage
Minimal usage:
var markdown = ;console;//=> <p>I am using <strong>remarked</strong>.</p>
API
.setOptions
Define remarked options with:
remarked ```jsvar remarked = require('remarked');remarked.setOptions({ renderer: new remarked.Renderer(), gfm: true, tables: true, breaks: false, pedantic: false, sanitize: true, smartLists: true, smartypants: false}); console.log(remarked('I am using **remarked**.'));
Why?
Assemble used marked.js extensively, but - for a couple of reasons - we've decided to maintain a fork so that our users can have a more reliable experience going forward.
- There are bugs, like escaping quotes automatically that prevent us from making marked.js a built-in parser.
- Given the massive amount of time and effort that we've put into fixing marked-related issues on the Assemble project and related projects
- Breaking changes are introduced to marked.js without bumping the minor version
- It does too much or too little with certain features. Like automatically adding ids to headings
Author
Jon Schlinkert
License
Copyright (c) 2014 Jon Schlinkert, contributors.
Based on marked https://github.com/chjj/marked Copyright (c) 2011-2014, Christopher Jeffrey, contributors. Released under the MIT License (MIT)
This file was generated by verb-cli on July 04, 2014.