A full-featured markdown parser and compiler, written in JavaScript. Built for speed.
This is fork of popular library marked from this commit
(Merge pull request #961 from chjj/release-0.3.7, Dec 1, 2017).
For now - work in progress (there is only alpha.1 version).
npm install marked --save
Minimal usage:
import { Marked } from 'marked';
console.log(Marked.parse('I am using __markdown__.'));
// Outputs: <p>I am using <strong>markdown</strong>.</p>
Example setting options with default values:
import { Marked, Renderer } from 'marked';
Marked.setOptions
({
renderer: new Renderer,
gfm: true,
tables: true,
breaks: false,
pedantic: false,
sanitize: false,
smartLists: true,
smartypants: false
});
console.log(Marked.parse('I am using __markdown__.'));
Minimal usage:
const marked = require('marked');
console.log(marked.Marked.parse('I am using __markdown__.'));
// Outputs: <p>I am using <strong>markdown</strong>.</p>
Example setting options with default values:
const marked = require('marked');
marked.Marked.setOptions
({
renderer: new marked.Renderer(),
gfm: true,
tables: true,
breaks: false,
pedantic: false,
sanitize: false,
smartLists: true,
smartypants: false
});
console.log(marked.Marked.parse('I am using __markdown__.'));
<!doctype html>
<html>
<head>
<meta charset="utf-8"/>
<title>Marked in the browser</title>
<script src="lib/marked.js"></script>
</head>
<body>
<div id="content"></div>
<script>
document.getElementById('content').innerHTML =
marked('# Marked in browser\n\nRendered by **marked**.');
</script>
</body>
</html>
Type: string
String of markdown source to be compiled.
Type: object
Hash of options. Can also be set using the marked.setOptions method as seen
above.
Type: function
Function called when the markdownString has been fully parsed when using
async highlighting. If the options argument is omitted, this can be used as
the second argument.
Type: function
A function to highlight code blocks. The first example below uses async highlighting with node-pygmentize-bundled, and the second is a synchronous example using highlight.js:
const marked = require('marked');
const markdownString = '```js\n console.log("hello"); \n```';
// Async highlighting with pygmentize-bundled
marked.setOptions({
highlight: function (code, lang, callback) {
require('pygmentize-bundled')({ lang: lang, format: 'html' }, code, function (err, result) {
callback(err, result.toString());
});
}
});
// Using async version of marked
marked(markdownString, function (err, content) {
if (err) throw err;
console.log(content);
});
// Synchronous highlighting with highlight.js
marked.setOptions({
highlight: function (code) {
return require('highlight.js').highlightAuto(code).value;
}
});
console.log(marked(markdownString));
code
Type: string
The section of code to pass to the highlighter.
lang
Type: string
The programming language specified in the code block.
callback
Type: function
The callback function to call when using an async highlighter.
Type: object
Default: new Renderer()
An object containing functions to render tokens to HTML.
The renderer option allows you to render tokens in a custom manner. Here is an example of overriding the default heading token rendering by adding an embedded anchor tag like on GitHub:
const marked = require('marked');
const renderer = new marked.Renderer();
renderer.heading = function (text, level) {
let escapedText = text.toLowerCase().replace(/[^\w]+/g, '-');
return '<h' + level + '><a name="' +
escapedText +
'" class="anchor" href="#' +
escapedText +
'"><span class="header-link"></span></a>' +
text + '</h' + level + '>';
},
console.log(marked('# heading+', { renderer: renderer }));
This code will output the following HTML:
<h1>
<a name="heading-" class="anchor" href="#heading-">
<span class="header-link"></span>
</a>
heading+
</h1>
flags has the following properties:
{
header: true || false,
align: 'center' || 'left' || 'right'
}
Type: boolean
Default: true
Enable GitHub flavored markdown.
Type: boolean
Default: true
Enable GFM tables.
This option requires the gfm option to be true.
Type: boolean
Default: false
Enable GFM line breaks.
This option requires the gfm option to be true.
Type: boolean
Default: false
Conform to obscure parts of markdown.pl as much as possible. Don't fix any of
the original markdown bugs or poor behavior.
Type: boolean
Default: false
Sanitize the output. Ignore any HTML that has been input.
Type: boolean
Default: true
Use smarter list behavior than the original markdown. May eventually be
default with the old behavior moved into pedantic.
Type: boolean
Default: false
Use "smart" typographic punctuation for things like quotes and dashes.
You also have direct access to the lexer and parser if you so desire.
const tokens = marked.lexer(text, options);
console.log(marked.parser(tokens));
const lexer = new marked.Lexer(options);
const tokens = lexer.lex(text);
console.log(tokens);
console.log(lexer.rules);
The point of marked was to create a markdown compiler where it was possible to frequently parse huge chunks of markdown without having to worry about caching the compiled output somehow...or blocking for an unnecessarily long time.
marked is very concise and still implements all markdown features. It is also now fully compatible with the client-side.
marked more or less passes the official markdown test suite in its entirety. This is important because a surprising number of markdown compilers cannot pass more than a few tests. It was very difficult to get marked as compliant as it is. It could have cut corners in several areas for the sake of performance, but did not in order to be exactly what you expect in terms of a markdown rendering. In fact, this is why marked could be considered at a disadvantage in the benchmarks above.
Along with implementing every markdown feature, marked also implements GFM features.
node v8.9.x
$ node dist-test/index.js --bench
| engine | completed in ms |
|---|---|
| marked-ts alpha.1 | 6 850 |
| marked-ts (gfm) alpha.1 | 7 101 |
| marked-ts (pedantic) alpha.1 | 6 248 |
| marked v0.3.7 | 6 429 |
| marked (gfm) v0.3.7 | 6 818 |
| marked (pedantic) v0.3.7 | 6 205 |
| remarkable v1.7.1 | 6 260 |
| markdown-it v8.4.0 | 7 026 |
| markdown v0.5.0 | 27 180 |
| showdown v1.8.5 | 42 775 |
For those feeling skeptical: These benchmarks run the entire markdown test suite 1000 times. The test suite tests every feature. It doesn't cater to specific aspects.
If you contribute code to this project, you are implicitly allowing your code
to be distributed under the MIT license. You are also implicitly verifying that
all code is your original work. </legalese>
Copyright (c) 2011-2014, Christopher Jeffrey. (MIT License)
Copyright (c) 2018, Костя Третяк. (MIT License)
See LICENSE for more info.
FAQs
A full-featured markdown parser and compiler, written in TypeScript
The npm package marked-ts receives a total of 703 weekly downloads. As such, marked-ts popularity was classified as not popular.
We found that marked-ts demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.