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>
|
2018-02-25 18:09:11 -05:00
|
|
|
|
2018-04-05 17:15:11 -04:00
|
|
|
# Marked
|
2018-02-25 14:18:59 -05:00
|
|
|
|
2018-08-06 11:22:35 -07:00
|
|
|
[](https://www.npmjs.com/package/marked)
|
2018-06-30 20:46:22 -04:00
|
|
|
[](https://cdn.jsdelivr.net/npm/marked/marked.min.js)
|
2018-06-30 20:42:55 -04:00
|
|
|
[](https://packagephobia.now.sh/result?p=marked)
|
2018-08-06 11:22:35 -07:00
|
|
|
[](https://www.npmjs.com/package/marked)
|
|
|
|
|
[](https://travis-ci.org/markedjs/marked)
|
2018-04-15 18:29:57 -04:00
|
|
|
|
2018-04-05 17:15:11 -04:00
|
|
|
- ⚡ built for speed
|
2018-04-06 16:12:17 -04:00
|
|
|
- ⬇️ low-level compiler for parsing markdown without caching or blocking for long periods of time
|
2018-04-05 17:15:11 -04:00
|
|
|
- ⚖️ light-weight while implementing all markdown features from the supported flavors & specifications
|
2018-04-06 16:12:17 -04:00
|
|
|
- 🌐 works in a browser, on a server, or from a command line interface (CLI)
|
2018-02-25 14:18:59 -05:00
|
|
|
|
2018-03-25 20:46:27 -04:00
|
|
|
## Demo
|
|
|
|
|
|
2018-03-27 15:44:02 +03:00
|
|
|
Checkout the [demo page](https://marked.js.org/demo/) to see marked in action ⛹️
|
2018-03-25 20:46:27 -04:00
|
|
|
|
2018-04-05 17:15:11 -04:00
|
|
|
## Docs
|
|
|
|
|
|
2018-03-25 20:46:27 -04:00
|
|
|
Our [documentation pages](https://marked.js.org) are also rendered using marked 💯
|
|
|
|
|
|
2018-07-18 00:47:31 +03:00
|
|
|
Also read about:
|
|
|
|
|
|
2018-07-18 23:54:29 +03:00
|
|
|
* [Options](https://marked.js.org/#/USING_ADVANCED.md)
|
|
|
|
|
* [Extensibility](https://marked.js.org/#/USING_PRO.md)
|
2018-07-18 00:47:31 +03:00
|
|
|
|
2018-03-11 17:32:23 -04:00
|
|
|
## Installation
|
2013-06-28 11:54:34 -07:00
|
|
|
|
2018-02-25 15:17:16 -05:00
|
|
|
**CLI:** `npm install -g marked`
|
2016-07-08 16:04:04 -03:00
|
|
|
|
2018-02-25 15:17:16 -05:00
|
|
|
**In-browser:** `npm install marked --save`
|
2016-07-08 16:04:04 -03:00
|
|
|
|
2018-06-24 01:56:52 -05:00
|
|
|
## Usage
|
|
|
|
|
|
2018-06-27 00:43:57 -05:00
|
|
|
### Warning: 🚨 Marked does not [sanitize](https://marked.js.org/#/USING_ADVANCED.md#options) the output HTML by default 🚨
|
2013-06-28 11:54:34 -07:00
|
|
|
|
2018-02-25 15:17:16 -05:00
|
|
|
**CLI**
|
2013-06-28 11:54:34 -07:00
|
|
|
|
2018-02-25 15:17:16 -05:00
|
|
|
``` bash
|
|
|
|
|
$ marked -o hello.html
|
|
|
|
|
hello world
|
|
|
|
|
^D
|
|
|
|
|
$ cat hello.html
|
|
|
|
|
<p>hello world</p>
|
2013-06-28 11:54:34 -07:00
|
|
|
```
|
|
|
|
|
|
2018-02-25 15:17:16 -05:00
|
|
|
**Browser**
|
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>
|
2018-03-25 20:36:41 -04:00
|
|
|
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
|
2014-05-06 15:48:15 +02:00
|
|
|
<script>
|
|
|
|
|
document.getElementById('content').innerHTML =
|
2018-03-11 17:32:23 -04:00
|
|
|
marked('# Marked in the browser\n\nRendered by **marked**.');
|
2014-05-06 15:48:15 +02:00
|
|
|
</script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
```
|
|
|
|
|
|
2018-03-11 17:32:23 -04:00
|
|
|
## License
|
2012-01-03 00:35:47 -06:00
|
|
|
|
2017-12-25 17:53:35 -05:00
|
|
|
Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)
|
