Skip to content
forked from markedjs/marked

A markdown parser and compiler. Built for speed.

License

Notifications You must be signed in to change notification settings

DoozyDoz/marked

This branch is 581 commits behind markedjs/marked:master.

Folders and files

NameName
Last commit message
Last commit date
Jan 8, 2023
Jan 14, 2023
Oct 31, 2022
Mar 30, 2022
Mar 22, 2023
Mar 22, 2023
Nov 2, 2021
Mar 22, 2023
Mar 22, 2023
Apr 5, 2018
Nov 5, 2019
Nov 23, 2020
Nov 11, 2021
Aug 15, 2020
Nov 2, 2021
Nov 18, 2020
Nov 2, 2021
Sep 12, 2022
Aug 11, 2020
Nov 2, 2021
Mar 30, 2022
Nov 2, 2021
Nov 2, 2021
Mar 22, 2023
Mar 27, 2023
Mar 27, 2023
Jan 14, 2023
Aug 29, 2020

Repository files navigation

Marked

npm gzip size install size downloads 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:

Compatibility

Node.js: Only current and LTS Node.js versions are supported. End of life Node.js versions may become incompatible with Marked at any point in time.

Browser: Not IE11 :)

Installation

CLI:

npm install -g marked

In-browser:

npm install marked
npm install @types/marked # For TypeScript projects

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

DOMPurify.sanitize(marked.parse(`<img src="x" onerror="alert('not happening')">`));

CLI

# Example with stdin input
$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>
# Print all options
$ marked --help

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.parse('# Marked in the browser\n\nRendered by **marked**.');
  </script>
</body>
</html>

License

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

About

A markdown parser and compiler. Built for speed.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 83.0%
  • HTML 16.9%
  • Makefile 0.1%