' + + desc: '\n\n
' +
'Describe Something in more detail here.
+
-> A full-featured markdown parser and compiler, written in JavaScript. Built
-> for speed.
+# Marked
-[][badge]
+[](https://www.npmjs.com/package/marked)
+[](https://cdn.jsdelivr.net/npm/marked@0.3.19/marked.min.js)
+[](https://packagephobia.now.sh/result?p=marked@0.3.19)
+[](https://www.npmjs.com/package/marked)
+[](https://travis-ci.org/markedjs/marked)
-## Install
+- ⚡ 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)
-``` bash
-npm install marked --save
-```
+## Demo
-## Usage
+Checkout the [demo page](https://marked.js.org/demo/) to see marked in action ⛹️
-Minimal usage:
+## Docs
-```js
-var marked = require('marked');
-console.log(marked('I am using __markdown__.'));
-// Outputs: I am using markdown.
-``` +Our [documentation pages](https://marked.js.org) are also rendered using marked 💯 + +## Installation + +**CLI:** `npm install -g marked` -Example setting options with default values: +**In-browser:** `npm install marked --save` -```js -var marked = require('marked'); -marked.setOptions({ - renderer: new marked.Renderer(), - gfm: true, - tables: true, - breaks: false, - pedantic: false, - sanitize: true, - smartLists: true, - smartypants: false -}); +## Usage -console.log(marked('I am using __markdown__.')); +**CLI** + +``` bash +$ marked -o hello.html +hello world +^D +$ cat hello.html +hello world
``` -### Browser +**Browser** ```html @@ -47,360 +49,19 @@ console.log(marked('I am using __markdown__.'));