README.md
1<ul>
2 <li><a href="#marked">About</a></li>
3 <li><a href="#demo">Demo</a></li>
4 <li><a href="#installation">Installation</a></li>
5 <li><a href="#usage">Usage</a></li>
6 <li><a href="#specifications">Supported Markdown specifications</a></li>
7 <li><a href="#security">Security</a></li>
8 <li><a href="#contributing">Contributing</a></li>
9 <li><a href="#authors">Authors</a></li>
10 <li><a href="#license">License</a></li>
11</ul>
12
13<h2 id="marked">Marked</h2>
14
15Marked is
16
171. built for speed.<sup>*</sup>
182. a low-level markdown compiler for parsing markdown without caching or blocking for long periods of time.<sup>**</sup>
193. light-weight while implementing all markdown features from the supported flavors & specifications.<sup>***</sup>
204. available as a command line interface (CLI) and running in client- or server-side JavaScript projects.
21
22<p><small><sup>*</sup> Still working on metrics for comparative analysis and definition.</small><br>
23<small><sup>**</sup> As few dependencies as possible.</small><br>
24<small><sup>***</sup> Strict compliance could result in slower processing when running comparative benchmarking.</small></p>
25
26
27<h2 id="demo">Demo</h2>
28
29Checkout the [demo page](./demo/) to see marked in action ⛹️
30
31These documentation pages are also rendered using marked ��
32
33
34<h2 id="installation">Installation</h2>
35
36**CLI:** `npm install -g marked`
37
38**In-browser:** `npm install marked --save`
39
40<h2 id="usage">Usage</h2>
41
42**CLI**
43
44``` bash
45$ marked -o hello.html
46hello world
47^D
48$ cat hello.html
49<p>hello world</p>
50```
51
52``` bash
53$ marked -s "*hello world*"
54<p><em>hello world</em></p>
55```
56
57**Browser**
58
59```html
60<!doctype html>
61<html>
62<head>
63 <meta charset="utf-8"/>
64 <title>Marked in the browser</title>
65</head>
66<body>
67 <div id="content"></div>
68 <script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
69 <script>
70 document.getElementById('content').innerHTML =
71 marked('# Marked in browser\n\nRendered by **marked**.');
72 </script>
73</body>
74</html>
75```
76
77
78Marked offers [advanced configurations](#/USING_ADVANCED.md) and [extensibility](#/USING_PRO.md) as well.
79
80<h2 id="specifications">Supported Markdown specifications</h2>
81
82We actively support the features of the following [Markdown flavors](https://github.com/commonmark/CommonMark/wiki/Markdown-Flavors).
83
84|Flavor |Version |
85|:----------------------------------------------------------|:----------|
86|The original markdown.pl |-- |
87|[CommonMark](http://spec.commonmark.org/0.28/) |0.28 |
88|[GitHub Flavored Markdown](https://github.github.com/gfm/) |0.28 |
89
90By 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.
91
92<h2 id="security">Security</h2>
93
94The 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.
95
96Therefore, please disclose potential security issues by email to the project [committers](#/AUTHORS.md) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). 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).
97
98<h2 id="contributing">Contributing</h2>
99
100The 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](#/CONTRIBUTING.md) for more details.
101
102For our Contribution License Agreement, see our [license](https://github.com/markedjs/marked/blob/master/LICENSE.md).
103
104<h2 id="authors">Authors</h2>
105
106For list of credited authors and contributors, please see our [authors page](#/AUTHORS.md).
107
108<h2 id="license">License</h2>
109
110Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)
111
112See [license](https://github.com/markedjs/marked/blob/master/LICENSE.md) for more details.
113