Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 3,601 Commits
.devcontainer		.devcontainer
.github		.github
api		api
bin		bin
docs		docs
man		man
src		src
test		test
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
.releaserc.json		.releaserc.json
CHANGELOG.md		CHANGELOG.md
LICENSE.md		LICENSE.md
README.md		README.md
SECURITY.md		SECURITY.md
esbuild.config.js		esbuild.config.js
eslint.config.js		eslint.config.js
package-lock.json		package-lock.json
package.json		package.json
tsconfig-type-test.json		tsconfig-type-test.json
tsconfig.json		tsconfig.json
vercel.json		vercel.json

Repository files navigation

Marked

⚡ 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 thedemo page to see marked in action ⛹️

Docs

Ourdocumentation pages are also rendered using marked 💯

Compatibility

Node.js: Onlycurrent 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

Warning: 🚨 Marked does notsanitize the output HTML. Please use a sanitize library, likeDOMPurify (recommended),sanitize-html orinsane on theoutput HTML! 🚨

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

CLI

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

# Print all options$ marked --help

Browser

<!doctype html><html><head><metacharset="utf-8"/><title>Marked in the browser</title></head><body><divid="content"></div><scriptsrc="https://cdn.jsdelivr.net/npm/marked/lib/marked.umd.js"></script><script>document.getElementById('content').innerHTML=marked.parse('# Marked in the browser\n\nRendered by **marked**.');</script></body></html>

or import esm module

<scripttype="module">import{marked}from"https://cdn.jsdelivr.net/npm/marked/lib/marked.esm.js";document.getElementById('content').innerHTML=marked.parse('# Marked in the browser\n\nRendered by **marked**.');</script>