Skip to content
A markdown parser and compiler. Built for speed.
JavaScript Makefile
Branch: master
Clone or download

Latest commit

styfle Merge pull request #1704 from jun-sheaf/master
Fixes ordered list ")" delimiter
1
Latest commit bd4757f Jun 17, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github fix build Apr 1, 2020
bin marked --help Dec 26, 2019
docs add favicon to docs Jun 16, 2020
lib Compiled Jun 17, 2020
man remove tables option Jul 2, 2019
src Fixed Example 272 Jun 17, 2020
test Fixed Example 272 Jun 17, 2020
.editorconfig style Apr 5, 2018
.eslintignore fix eslint config Nov 5, 2019
.eslintrc.json create tokens before sending to parser Apr 2, 2020
.gitattributes Fix GitHub language via override Feb 15, 2018
.gitignore Ignore DS_Store on macos Mar 23, 2018
.nowignore Add .nowignore Feb 5, 2020
LICENSE.md Move license back to root dir Oct 17, 2018
Makefile generate textual manpage Jan 9, 2018
README.md update readme badge Apr 1, 2020
SECURITY.md add links May 23, 2019
bower.json Fix urls to markedjs Mar 3, 2018
component.json Fix urls to markedjs Mar 3, 2018
index.js index Aug 14, 2011
jasmine.json abstract htmldiffer Mar 13, 2019
marked.min.js Compiled Jun 17, 2020
now.json Cleanup now.json Feb 5, 2020
package-lock.json 1.1.0 May 16, 2020
package.json 1.1.0 May 16, 2020
rollup.config.esm.js Update copyright year Nov 11, 2019
rollup.config.js Use Babel's loose mode for shorted & more performant code Dec 4, 2019

README.md

Marked

npm gzip size install size downloads dep dev dep github actions 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. Please use a sanitize library, like DOMPurify (recommended), sanitize-html or insane on the output HTML! 🚨

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)

You can’t perform that action at this time.