@dr.pogodin/marked
TypeScript icon, indicating that this package has built-in type declarations

9.0.3 • Public • Published

Marked (Unofficial Build for Older Environments)

Latest NPM Release NPM Downloads CircleCI GitHub Repo stars Dr. Pogodin Studio

This is an unofficial fork of marked library, built for ES2017 target, instead of ES2022, thus supporting older environments. Otherwise, it is an exact copy of the upstream. It is published to NPM as @dr.pogodin/marked.

— BELOW THIS POINT IS THE ORIGINAL MARKED DOCUMENTATION —

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

Usage

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)

Readme

Keywords

Package Sidebar

Install

npm i @dr.pogodin/marked

Weekly Downloads

2

Version

9.0.3

License

MIT

Unpacked Size

971 kB

Total Files

15

Last publish

Collaborators

  • dr.pogodin