# Marked [![npm](https://badgen.net/npm/v/marked)](https://www.npmjs.com/package/marked) [![gzip size](https://badgen.net/badgesize/gzip/https://cdn.jsdelivr.net/npm/marked/marked.min.js)](https://cdn.jsdelivr.net/npm/marked/marked.min.js) [![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) [![dep](https://badgen.net/david/dep/markedjs/marked?label=deps)](https://david-dm.org/markedjs/marked) [![dev dep](https://badgen.net/david/dev/markedjs/marked?label=devDeps)](https://david-dm.org/markedjs/marked?type=dev) [![travis](https://badgen.net/travis/markedjs/marked)](https://travis-ci.org/markedjs/marked) [![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.md) * [Extensibility](https://marked.js.org/#/USING_PRO.md) ## Installation **CLI:** `npm install -g marked` **In-browser:** `npm install marked` ## Usage ### Warning: 🚨 Marked does not [sanitize](https://marked.js.org/#/USING_ADVANCED.md#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! 🚨 **CLI** ``` bash $ marked -o hello.html hello world ^D $ cat hello.html

hello world

``` **Browser** ```html Marked in the browser
``` ## License Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)