marked

mirror of https://github.com/markedjs/marked synced 2024-11-22 08:12:33 +00:00

History

Kyo Nagashima 007756e7e7 Add missing parameters for renderer methods Some renderer methods have more parameters than documented. Let’s update them.		2018-07-29 00:20:04 +09:00
..
demo	lint	2018-06-24 02:02:11 -05:00
img	pre-commit	2018-03-20 20:20:31 -04:00
AUTHORS.md	Separate table of core team vs contributors	2018-06-27 15:17:18 -04:00
broken.md	pre-commit	2018-03-20 20:20:31 -04:00
CNAME	pre-commit	2018-03-20 20:20:31 -04:00
CODE_OF_CONDUCT.md	Merge pull request #1168 from UziTech/hash-change-docs	2018-03-27 19:46:11 -04:00
CONTRIBUTING.md	add slash at beginning	2018-03-27 14:08:25 -05:00
index.html	add slash at beginning	2018-03-27 14:08:25 -05:00
PUBLISHING.md	Remove details	2018-04-25 08:33:13 -04:00
README.md	link to options	2018-06-27 00:43:57 -05:00
USING_ADVANCED.md	Update USING_ADVANCED.md	2018-05-24 12:08:07 -06:00
USING_PRO.md	Add missing parameters for renderer methods	2018-07-29 00:20:04 +09:00

Marked

Marked is

built for speed.^*
a low-level markdown compiler for parsing 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.

Demo

Checkout the demo page to see marked in action ⛹️

These documentation pages are also rendered using marked 💯

Installation

CLI: npm install -g marked

In-browser: npm install marked --save

Usage

Warning: 🚨 Marked does not sanitize the output HTML by default 🚨

CLI

$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>

$ marked -s "*hello world*"
<p><em>hello world</em></p>

Browser

<!doctype html>
<html>
<head>
  <meta charset="utf-8"/>
  <title>Marked in the browser</title>
</head>
<body>
  <div id="content"></div>
  <script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
  <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.

Security

The only completely secure system is the one that doesn't exist in the first place. Having said that, we take the security of Marked very seriously.

Therefore, please disclose potential security issues by email to the project committers as well as the listed owners within NPM. We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue).

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 each other improve as professionals while helping Marked improve 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

See license for more details.