marked/README.md

<ul>
  <li><a href="#marked">About</a></li>
  <li><a href="#install">Installation</a></li>
  <li><a href="#usage">Usage</a></li>
  <li><a href="#specifications">Supported Markdown specifications</a></li>
  <li><a href="#security">Security</a></li>
  <li><a href="#contributing">Contributing</a></li>
  <li><a href="#authors">Authors</a></li>
  <li><a href="#license">License</a></li>
</ul>

<h2 id="marked">Marked</h2>

Marked is 

1. built for speed.<sup>*</sup>
2. a low-level markdown compiler that allows frequent parsing of large chunks of markdown without caching or blocking for long periods of time.<sup>**</sup>
3. light-weight while implementing all markdown features from the supported flavors & specifications.<sup>***</sup>
4. available as a command line interface (CLI) and running in client- or server-side JavaScript projects.

<p><small><sup>*</sup> Still working on metrics for comparative analysis and definition.</small><br>
<small><sup>**</sup> As few dependencies as possible.</small><br>
<small><sup>***</sup> Strict compliance could result in slower processing when running comparative benchmarking.</small></p>

<h2 id="installation">Installation</h2>

**CLI:** `npm install -g marked`

**In-browser:** `npm install marked --save`

<h2 id="usage">Usage</h2>

**CLI**

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

**Browser**

```html
<!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](https://github.com/markedjs/marked/blob/master/USAGE_ADVANCED.md) and [extensibility](https://github.com/markedjs/marked/blob/master/USAGE_EXTENSIBILITY.md) as well.

<h2 id="specifications">Supported Markdown specifications</h2>

We actively support the features of the following [Markdown flavors](https://github.com/commonmark/CommonMark/wiki/Markdown-Flavors).

|Flavor                                                     |Version    |
|:----------------------------------------------------------|:----------|
|The original markdown.pl                                   |--         |
|[CommonMark](http://spec.commonmark.org/0.28/)             |0.28       |
|[GitHub Flavored Markdown](https://github.github.com/gfm/) |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.

<h2 id="security">Security</h2>

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](https://github.com/markedjs/marked/blob/master/AUTHORS.md). 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).

<h2 id="contributing">Contributing</h2>

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](https://github.com/markedjs/marked/blob/master/CONTRIBUTING.md) for more details.

For our Contribution License Agreement, see our [license](https://github.com/markedjs/marked/blob/master/LICENSE.md).

<h2 id="authors">Authors</h2>

For list of credited authors and contributors, please see our [authors page](https://github.com/markedjs/marked/blob/master/AUTHORS.md).

<h2 id="license">License</h2>

Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)

See [license](https://github.com/markedjs/marked/blob/master/LICENSE.md) for more details.
Move TOC to top 2018-02-25 18:09:11 -05:00			`<ul>`
			`<li><a href="#marked">About</a></li>`
			`<li><a href="#install">Installation</a></li>`
			`<li><a href="#usage">Usage</a></li>`
			`<li><a href="#specifications">Supported Markdown specifications</a></li>`
Add security section to README 2018-02-25 20:28:21 -05:00			`<li><a href="#security">Security</a></li>`
Move TOC to top 2018-02-25 18:09:11 -05:00			`<li><a href="#contributing">Contributing</a></li>`
			`<li><a href="#authors">Authors</a></li>`
			`<li><a href="#license">License</a></li>`
			`</ul>`

Used Marked as header test 2018-02-25 18:09:40 -05:00			`<h2 id="marked">Marked</h2>`
Move TOC to top 2018-02-25 18:09:11 -05:00
Initial product vision 2018-02-25 14:18:59 -05:00			`Marked is`

			`1. built for speed.<sup>*</sup>`
			`2. a low-level markdown compiler that allows frequent parsing of large chunks of markdown without caching or blocking for long periods of time.<sup>**</sup>`
			`3. light-weight while implementing all markdown features from the supported flavors & specifications.<sup>***</sup>`
Add advanced usage 2018-02-25 15:17:16 -05:00			`4. available as a command line interface (CLI) and running in client- or server-side JavaScript projects.`
Initial product vision 2018-02-25 14:18:59 -05:00
Beginning RELEASE refinement 2018-02-25 17:58:24 -05:00			`<p><small><sup>*</sup> Still working on metrics for comparative analysis and definition.</small><br>`
			`<small><sup>**</sup> As few dependencies as possible.</small><br>`
			`<small><sup>***</sup> Strict compliance could result in slower processing when running comparative benchmarking.</small></p>`
Updated README 2013-06-28 11:54:34 -07:00
Add advanced usage 2018-02-25 15:17:16 -05:00			`<h2 id="installation">Installation</h2>`
Updated README 2013-06-28 11:54:34 -07:00
Add advanced usage 2018-02-25 15:17:16 -05:00			CLI: `npm install -g marked`
Update README to account for npm run-script usage 2016-07-08 16:04:04 -03:00
Add advanced usage 2018-02-25 15:17:16 -05:00			In-browser: `npm install marked --save`
Update README to account for npm run-script usage 2016-07-08 16:04:04 -03:00
Update read me with TOC & other changes 2018-02-18 22:19:37 -06:00			`<h2 id="usage">Usage</h2>`
Updated README 2013-06-28 11:54:34 -07:00
Add advanced usage 2018-02-25 15:17:16 -05:00			`CLI`
Updated README 2013-06-28 11:54:34 -07:00
Add advanced usage 2018-02-25 15:17:16 -05:00			``` bash
			`$ marked -o hello.html`
			`hello world`
			`^D`
			`$ cat hello.html`
			`<p>hello world</p>`
Updated README 2013-06-28 11:54:34 -07:00			```

Add advanced usage 2018-02-25 15:17:16 -05:00			`Browser`
Add browser usage to README. 2014-05-06 15:48:15 +02:00
			```html
			`<!doctype html>`
			`<html>`
			`<head>`
			`<meta charset="utf-8"/>`
			`<title>Marked in the browser</title>`
Add advanced usage 2018-02-25 15:17:16 -05:00			`<script src="/path/to/marked.min.js"></script>`
Add browser usage to README. 2014-05-06 15:48:15 +02:00			`</head>`
			`<body>`
			`<div id="content"></div>`
			`<script>`
			`document.getElementById('content').innerHTML =`
			`marked('# Marked in browser\n\nRendered by marked.');`
			`</script>`
			`</body>`
			`</html>`
			```

Updated README 2013-06-28 11:54:34 -07:00
Base README 2018-02-25 16:01:22 -05:00			`Marked offers [advanced configurations](https://github.com/markedjs/marked/blob/master/USAGE_ADVANCED.md) and [extensibility](https://github.com/markedjs/marked/blob/master/USAGE_EXTENSIBILITY.md) as well.`
Document the xhtml option 2017-10-06 20:40:21 -04:00
Base README 2018-02-25 16:01:22 -05:00			`<h2 id="specifications">Supported Markdown specifications</h2>`
add contributing section to readme. 2013-08-07 10:36:54 -05:00
Base README 2018-02-25 16:01:22 -05:00			`We actively support the features of the following [Markdown flavors](https://github.com/commonmark/CommonMark/wiki/Markdown-Flavors).`
Updated README 2013-06-28 11:54:34 -07:00
Base README 2018-02-25 16:01:22 -05:00			`\|Flavor \|Version \|`
			`\|:----------------------------------------------------------\|:----------\|`
			`\|The original markdown.pl \|-- \|`
			`\|[CommonMark](http://spec.commonmark.org/0.28/) \|0.28 \|`
			`\|[GitHub Flavored Markdown](https://github.github.com/gfm/) \|0.28 \|`
add readme for renderer 2013-03-01 14:12:17 +08:00
Base README 2018-02-25 16:01:22 -05:00			`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.`
add readme for renderer 2013-03-01 14:12:17 +08:00
Add security section to README 2018-02-25 20:28:21 -05:00			`<h2 id="security">Security</h2>`

Update security section 2018-02-27 13:16:03 -05:00			`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](https://github.com/markedjs/marked/blob/master/AUTHORS.md). 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).`
benchmarks, readme 2011-08-26 05:20:42 -05:00
Update read me with TOC & other changes 2018-02-18 22:19:37 -06:00			`<h2 id="contributing">Contributing</h2>`

Make Contributing text in README less pretentious sounding 2018-02-25 19:11:59 -05:00			`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](https://github.com/markedjs/marked/blob/master/CONTRIBUTING.md) for more details.`
Update read me with TOC & other changes 2018-02-18 22:19:37 -06:00
Add AUTHORS page 2018-02-25 16:20:20 -05:00			`For our Contribution License Agreement, see our [license](https://github.com/markedjs/marked/blob/master/LICENSE.md).`

			`<h2 id="authors">Authors</h2>`

			`For list of credited authors and contributors, please see our [authors page](https://github.com/markedjs/marked/blob/master/AUTHORS.md).`
Update read me with TOC & other changes 2018-02-18 22:19:37 -06:00
			`<h2 id="license">License</h2>`
update readme and license 2012-01-03 00:35:47 -06:00
Update copyright to 2018 in README Because the new year is upon us 2017-12-25 17:53:35 -05:00			`Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)`
update readme and license 2012-01-03 00:35:47 -06:00
Add AUTHORS page 2018-02-25 16:20:20 -05:00			`See [license](https://github.com/markedjs/marked/blob/master/LICENSE.md) for more details.`
add contributing section to readme. 2013-08-07 10:36:54 -05:00