3.5 KiB
Marked
Marked is
- built for speed.*
- a low-level markdown compiler that allows frequent parsing of large chunks of markdown without caching or blocking for long periods of time.**
- light-weight while implementing all markdown features from the supported flavors & specifications.***
- available as a command line interface (CLI) and running in client- or server-side JavaScript projects.
* Still working on metrics for comparative analysis and definition.
** As few dependencies as possible.
*** Strict compliance could result in slower processing when running comparative benchmarking.
Installation
CLI: npm install -g marked
In-browser: npm install marked --save
Usage
CLI
$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>
Browser
<!doctype html>
<html>
<head>
<meta charset="utf-8"/>
<title>Marked in the browser</title>
<script src="/path/to/marked.min.js"></script>
</head>
<body>
<div id="content"></div>
<script>
document.getElementById('content').innerHTML =
marked('# Marked in browser\n\nRendered by **marked**.');
</script>
</body>
</html>
Marked offers advanced configurations and extensibility as well.
Supported Markdown specifications
We actively support the features of the following Markdown flavors.
| Flavor | Version |
|---|---|
| The original markdown.pl | -- |
| CommonMark | 0.28 |
| GitHub Flavored Markdown | 0.28 |
By supporting the above Markdown flavors, it's possible that Marked can help you use other flavors as well; however, these are not actively supported by the community.
Contributing
The marked community enjoys a spirit of collaboration and contribution from all comers. Whether you're just getting started with Markdown, JavaScript, and Marked or you're a veteran with it all figured out, we're here to help you improve as a professionally while helping improve Marked technically. Please see our contributing documentation for more details.
For our Contribution License Agreement, see our license.
Authors
For list of credited authors and contributors, please see our authors page.
License
Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)
See license for more details.