Awesome community module

Marked

npm gzip size install size downloads travis

  • ⚡ 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 to see marked in action ⛹️

Docs

Our documentation pages are also rendered using marked 💯

Installation

CLI: npm install -g marked

In-browser: npm install marked --save

Usage

CLI

1 2 3 4 5
$ marked -o hello.html hello world ^D $ cat hello.html <p>hello world</p>

Browser

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
<!doctype html> <html> <head> <meta charset="utf-8"/> <title>Marked in the browser</title> </head> <body> <div id="content"></div> <script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script> <script> document.getElementById('content').innerHTML = marked('# Marked in the browser\n\nRendered by **marked**.'); </script> </body> </html>

License

Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)