Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

marked

0.4.0 • Public • Published

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

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

install

npm i marked

Downloadsweekly downloads

515,768

version

0.4.0

license

MIT

repository

githubgithub

last publish

collaborators

  • avatar
  • avatar