Skip to content

markedjs/marked

Folders and files

NameName
Last commit message
Last commit date

Latest commit

d9f22d2 · May 4, 2019
May 11, 2018
May 4, 2019
May 4, 2019
May 4, 2019
Mar 12, 2019
May 4, 2019
Apr 5, 2018
Mar 29, 2018
May 4, 2019
Feb 15, 2018
Mar 23, 2018
Oct 28, 2018
Oct 17, 2018
Jan 9, 2018
Feb 19, 2019
Mar 3, 2018
Mar 3, 2018
Aug 14, 2011
Mar 13, 2019
Apr 5, 2019
May 4, 2019
May 4, 2019

Repository files navigation

Marked

npm gzip size install size downloads dep dev dep travis snyk

  • ⚡ 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 💯

Also read about:

Installation

CLI: npm install -g marked

In-browser: npm install marked

Usage

Warning: 🚨 Marked does not sanitize the output HTML by default 🚨

CLI

$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>

Browser

<!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)