marked/README.md

<a href="https://marked.js.org">
  <img width="60px" height="60px" src="https://marked.js.org/img/logo-black.svg" align="right" />
</a>

# Marked

[![npm](https://badgen.net/npm/v/marked)](https://www.npmjs.com/package/marked)
[![install size](https://badgen.net/packagephobia/install/marked)](https://packagephobia.now.sh/result?p=marked)
[![downloads](https://badgen.net/npm/dt/marked)](https://www.npmjs.com/package/marked)
[![github actions](https://github.com/markedjs/marked/workflows/Tests/badge.svg)](https://github.com/markedjs/marked/actions)
[![snyk](https://snyk.io/test/npm/marked/badge.svg)](https://snyk.io/test/npm/marked)

- ⚡ built for speed
- ⬇️ low-level 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
- 🌐 works in a browser, on a server, or from a command line interface (CLI)

## Demo

Checkout the [demo page](https://marked.js.org/demo/) to see marked in action ⛹️

## Docs

Our [documentation pages](https://marked.js.org) are also rendered using marked 💯

Also read about:

* [Options](https://marked.js.org/using_advanced)
* [Extensibility](https://marked.js.org/using_pro)

## Compatibility

**Node.js:** Only [current and LTS](https://nodejs.org/en/about/releases/) Node.js versions are supported. End of life Node.js versions may become incompatible with Marked at any point in time.

**Browser:** Not IE11 :)

## Installation

**CLI:**

```sh
npm install -g marked
```

**In-browser:**

```sh
npm install marked
```

## Usage

### Warning: 🚨 Marked does not [sanitize](https://marked.js.org/using_advanced#options) the output HTML. Please use a sanitize library, like [DOMPurify](https://github.com/cure53/DOMPurify) (recommended), [sanitize-html](https://github.com/apostrophecms/sanitize-html) or [insane](https://github.com/bevacqua/insane) on the *output* HTML! 🚨

```
DOMPurify.sanitize(marked.parse(`<img src="x" onerror="alert('not happening')">`));
```

**CLI**

``` bash
# Example with stdin input
$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>
```

```bash
# Print all options
$ marked --help
```

**Browser**

```html
<!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.parse('# Marked in the browser\n\nRendered by **marked**.');
  </script>
</body>
</html>
```
or import esm module

```html
<script type="module">
  import { marked } from "https://cdn.jsdelivr.net/npm/marked/lib/marked.esm.js";
  document.getElementById('content').innerHTML =
    marked.parse('# Marked in the browser\n\nRendered by **marked**.');
</script>
```

## License

Copyright (c) 2011-2022, Christopher Jeffrey. (MIT License)
Decrease size of logo 2018-04-05 20:47:03 -04:00			`<a href="https://marked.js.org">`
			`<img width="60px" height="60px" src="https://marked.js.org/img/logo-black.svg" align="right" />`
			`</a>`
Move TOC to top 2018-02-25 18:09:11 -05:00
Update readme with emoji 2018-04-05 17:15:11 -04:00			`# Marked`
Initial product vision 2018-02-25 14:18:59 -05:00
Change badges to use badgen 2018-08-06 11:22:35 -07:00			`[![npm](https://badgen.net/npm/v/marked)](https://www.npmjs.com/package/marked)`
Change packagephobia badge to badgen 2018-08-06 18:36:38 -05:00			`[![install size](https://badgen.net/packagephobia/install/marked)](https://packagephobia.now.sh/result?p=marked)`
Change badges to use badgen 2018-08-06 11:22:35 -07:00			`[![downloads](https://badgen.net/npm/dt/marked)](https://www.npmjs.com/package/marked)`
update readme badge 2020-04-01 00:53:50 -05:00			`[![github actions](https://github.com/markedjs/marked/workflows/Tests/badge.svg)](https://github.com/markedjs/marked/actions)`
Add snyk badge This adds a new badge to the readme called `vulnerabilities` linking to snyk. I also made the other badges a bit smaller so everything fits on one line. 2019-02-18 08:57:18 -05:00			`[![snyk](https://snyk.io/test/npm/marked/badge.svg)](https://snyk.io/test/npm/marked)`
Add badges to README 2018-04-15 18:29:57 -04:00
Update readme with emoji 2018-04-05 17:15:11 -04:00			`- ⚡ built for speed`
Change "the" to "a" 2018-04-06 16:12:17 -04:00			`- ⬇️ low-level compiler for parsing markdown without caching or blocking for long periods of time`
Update readme with emoji 2018-04-05 17:15:11 -04:00			`- ⚖️ light-weight while implementing all markdown features from the supported flavors & specifications`
Change "the" to "a" 2018-04-06 16:12:17 -04:00			`- 🌐 works in a browser, on a server, or from a command line interface (CLI)`
Initial product vision 2018-02-25 14:18:59 -05:00
Add link to demo from readme 2018-03-25 20:46:27 -04:00			`## Demo`

Update link to demo page in README.md 2018-03-27 15:44:02 +03:00			`Checkout the [demo page](https://marked.js.org/demo/) to see marked in action ⛹️`
Add link to demo from readme 2018-03-25 20:46:27 -04:00
Update readme with emoji 2018-04-05 17:15:11 -04:00			`## Docs`

Add link to demo from readme 2018-03-25 20:46:27 -04:00			`Our [documentation pages](https://marked.js.org) are also rendered using marked 💯`

[docs] Add additional links 2018-07-18 00:47:31 +03:00			`Also read about:`

docs: Correcting links to documentation (#3046) 2023-10-17 08:18:16 +03:30			`* [Options](https://marked.js.org/using_advanced)`
			`* [Extensibility](https://marked.js.org/using_pro)`
[docs] Add additional links 2018-07-18 00:47:31 +03:00
chore(docs): Add note about supported versions (#1938) 2021-08-16 15:19:44 +01:00			`## Compatibility`

			`Node.js: Only [current and LTS](https://nodejs.org/en/about/releases/) Node.js versions are supported. End of life Node.js versions may become incompatible with Marked at any point in time.`

			`Browser: Not IE11 :)`

Move most of README.md to /docs/README.md 2018-03-11 17:32:23 -04:00			`## Installation`
Updated README 2013-06-28 11:54:34 -07:00
docs: add docs for esm in browser (#3107) 2023-11-28 08:12:06 -07:00			`CLI:`
Update README to account for npm run-script usage 2016-07-08 16:04:04 -03:00
docs: add docs for esm in browser (#3107) 2023-11-28 08:12:06 -07:00			```sh
chore(docs): Update installation instructions (#2489) 2022-06-01 08:30:51 +05:30			`npm install -g marked`
			```

docs: add docs for esm in browser (#3107) 2023-11-28 08:12:06 -07:00			`In-browser:`
chore(docs): Update installation instructions (#2489) 2022-06-01 08:30:51 +05:30
			```sh
			`npm install marked`
			```
Update README to account for npm run-script usage 2016-07-08 16:04:04 -03:00
add warning to README and docs 2018-06-24 01:56:52 -05:00			`## Usage`

docs: Correcting links to documentation (#3046) 2023-10-17 08:18:16 +03:30			`### Warning: 🚨 Marked does not [sanitize](https://marked.js.org/using_advanced#options) the output HTML. Please use a sanitize library, like [DOMPurify](https://github.com/cure53/DOMPurify) (recommended), [sanitize-html](https://github.com/apostrophecms/sanitize-html) or [insane](https://github.com/bevacqua/insane) on the output HTML! 🚨`
Updated README 2013-06-28 11:54:34 -07:00
chore(docs): add a secure example to the documentation. (#2462) * Add a sanitized example * Remove ! * move example below warning Co-authored-by: Florian Hantke <florian.hantke@cispa.de> 2022-05-07 18:37:21 +02:00			```
			DOMPurify.sanitize(marked.parse(`<img src="x" onerror="alert('not happening')">`));
			```
Updated README 2013-06-28 11:54:34 -07:00
chore(docs): add a secure example to the documentation. (#2462) * Add a sanitized example * Remove ! * move example below warning Co-authored-by: Florian Hantke <florian.hantke@cispa.de> 2022-05-07 18:37:21 +02:00			`CLI`
chore(docs): Improved CLI Examples (#2303) 2021-11-24 22:19:58 +01:00
Add advanced usage 2018-02-25 15:17:16 -05:00			``` bash
chore(docs): Improved CLI Examples (#2303) 2021-11-24 22:19:58 +01:00			`# Example with stdin input`
Add advanced usage 2018-02-25 15:17:16 -05:00			`$ marked -o hello.html`
			`hello world`
			`^D`
			`$ cat hello.html`
			`<p>hello world</p>`
Updated README 2013-06-28 11:54:34 -07:00			```

chore(docs): Improved CLI Examples (#2303) 2021-11-24 22:19:58 +01:00			```bash
			`# Print all options`
			`$ marked --help`
			```

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>`
			`</head>`
			`<body>`
			`<div id="content"></div>`
Move script to the bottom 2018-03-25 20:36:41 -04:00			`<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>`
Add browser usage to README. 2014-05-06 15:48:15 +02:00			`<script>`
			`document.getElementById('content').innerHTML =`
fix: Convert to ESM (#2227) BREAKING CHANGE: - Default export removed. Use `import { marked } from 'marked'` or `const { marked } = require('marked')` instead. - `/lib/marked.js` removed. Use `/marked.min.js` in script tag instead. - When using marked in a script tag use `marked.parse(...)` instead of `marked(...)` 2021-11-02 07:32:17 -07:00			`marked.parse('# Marked in the browser\n\nRendered by marked.');`
Add browser usage to README. 2014-05-06 15:48:15 +02:00			`</script>`
			`</body>`
			`</html>`
			```
docs: add docs for esm in browser (#3107) 2023-11-28 08:12:06 -07:00			`or import esm module`

			```html
			`<script type="module">`
			`import { marked } from "https://cdn.jsdelivr.net/npm/marked/lib/marked.esm.js";`
			`document.getElementById('content').innerHTML =`
			`marked.parse('# Marked in the browser\n\nRendered by marked.');`
			`</script>`
			```
Add browser usage to README. 2014-05-06 15:48:15 +02:00
Move most of README.md to /docs/README.md 2018-03-11 17:32:23 -04:00			`## License`
update readme and license 2012-01-03 00:35:47 -06:00
chore(readme): fix copyright date (#2356) 2022-01-14 21:35:30 +05:30			`Copyright (c) 2011-2022, Christopher Jeffrey. (MIT License)`