{"_attachments":{},"_id":"marked","_rev":"367-61b71ee7686532287ed4e419","author":{"name":"Christopher Jeffrey"},"description":"A markdown parser built for speed","dist-tags":{"latest":"12.0.1"},"license":"MIT","maintainers":[{"name":"styfle","email":"steven@ceriously.com"},{"name":"amidknight","email":"josh@8fold.pro"},{"name":"tonybrix","email":"tony@brix.ninja"},{"name":"chjj","email":"chjjeffrey@gmail.com"}],"name":"marked","readme":"\n \n\n\n# Marked\n\n[![npm](https://badgen.net/npm/v/marked)](https://www.npmjs.com/package/marked)\n[![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)\n[![install size](https://badgen.net/packagephobia/install/marked)](https://packagephobia.now.sh/result?p=marked)\n[![downloads](https://badgen.net/npm/dt/marked)](https://www.npmjs.com/package/marked)\n[![github actions](https://github.com/markedjs/marked/workflows/Tests/badge.svg)](https://github.com/markedjs/marked/actions)\n[![snyk](https://snyk.io/test/npm/marked/badge.svg)](https://snyk.io/test/npm/marked)\n\n- ⚡ built for speed\n- ⬇️ low-level compiler for parsing markdown without caching or blocking for long periods of time\n- ⚖️ light-weight while implementing all markdown features from the supported flavors & specifications\n- 🌐 works in a browser, on a server, or from a command line interface (CLI)\n\n## Demo\n\nCheckout the [demo page](https://marked.js.org/demo/) to see marked in action ⛹️\n\n## Docs\n\nOur [documentation pages](https://marked.js.org) are also rendered using marked 💯\n\nAlso read about:\n\n* [Options](https://marked.js.org/using_advanced)\n* [Extensibility](https://marked.js.org/using_pro)\n\n## Compatibility\n\n**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.\n\n**Browser:** Not IE11 :)\n\n## Installation\n\n**CLI:**\n\n```sh\nnpm install -g marked\n```\n\n**In-browser:**\n\n```sh\nnpm install marked\n```\n\n## Usage\n\n### 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! 🚨\n\n```\nDOMPurify.sanitize(marked.parse(``));\n```\n\n**CLI**\n\n``` bash\n# Example with stdin input\n$ marked -o hello.html\nhello world\n^D\n$ cat hello.html\n
hello world
\n```\n\n```bash\n# Print all options\n$ marked --help\n```\n\n**Browser**\n\n```html\n\n\n\n \n