# Marked in the browser

# 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(``)); ``` **CLI** ``` bash # Example with stdin input $ marked -o hello.html hello world ^D $ cat hello.html

hello world

``` ```bash # Print all options $ marked --help ``` **Browser** ```html
``` or import esm module ```html
``` ## License Copyright (c) 2011-2022, Christopher Jeffrey. (MIT License)