What is this?
Marked is a markdown parser and compiler built for speed. You feed it markdown text and get HTML back, and it runs in a browser, on a server, or from the command line.
Marked is a markdown parser and compiler built for speed. You feed it markdown text and get HTML back, and it runs in a browser, on a server, or from the command line.Is it a library I code against, or a finished app?A JavaScript library you call from your own code, plus a small CLI for converting markdown right in the terminal. There is also a demo page if you just want to paste markdown and see the result.
A JavaScript library you call from your own code, plus a small CLI for converting markdown right in the terminal. There is also a demo page if you just want to paste markdown and see the result.How do I add it to a project?Install from npm: globally for the CLI (npm install -g marked) or as a project dependency for library use; in the browser, load it via a script tag or import the ESM module. Docs live at marked.js.org.
Install from npm: globally for the CLI (npm install -g marked) or as a project dependency for library use; in the browser, load it via a script tag or import the ESM module. Docs live at marked.js.org.What do I need installed for it to work?For server or CLI use, a supported Node.js: only current and LTS releases, with the package targeting Node 20+. In the browser, any Baseline Widely Available browser works, and the library itself ships with zero runtime dependencies.
For server or CLI use, a supported Node.js: only current and LTS releases, with the package targeting Node 20+. In the browser, any Baseline Widely Available browser works, and the library itself ships with zero runtime dependencies.Is the HTML it produces safe to drop straight into my page?No — Marked does not sanitize its output. If any of the markdown can come from users, run the resulting HTML through a sanitizer like DOMPurify (recommended), sanitize-html or insane first.
No — Marked does not sanitize its output. If any of the markdown can come from users, run the resulting HTML through a sanitizer like DOMPurify (recommended), sanitize-html or insane first.Where does it run?Anywhere JavaScript runs: modern browsers (Baseline Widely Available), Node.js on a server, and the terminal through its CLI.
Anywhere JavaScript runs: modern browsers (Baseline Widely Available), Node.js on a server, and the terminal through its CLI.How is it licensed?MIT, so it is free to use in personal and commercial projects. Copyright is held by MarkedJS (2018+) and Christopher Jeffrey (2011-2018).
MIT, so it is free to use in personal and commercial projects. Copyright is held by MarkedJS (2018+) and Christopher Jeffrey (2011-2018).What is Marked's main selling point?Speed and light weight: it is a low-level compiler that parses markdown without caching or blocking for long periods, while staying light-weight and implementing all markdown features from the supported flavors and specifications.
Speed and light weight: it is a low-level compiler that parses markdown without caching or blocking for long periods, while staying light-weight and implementing all markdown features from the supported flavors and specifications.Does it support GFM and CommonMark?It implements all markdown features from the supported flavors and specifications, and the repo explicitly tracks the commonmark and gfm specs among its topics.
It implements all markdown features from the supported flavors and specifications, and the repo explicitly tracks the commonmark and gfm specs among its topics.Can I add custom syntax or behavior?Yes. Extensibility is a core feature: Marked is easily adaptable with custom extensions, and the documentation covers an Extensibility section alongside the Options reference.
Yes. Extensibility is a core feature: Marked is easily adaptable with custom extensions, and the documentation covers an Extensibility section alongside the Options reference.Is there an easy way to try it before installing?Yes — the README links a demo page where you can see Marked in action, and the documentation site itself is rendered using Marked.
Yes — the README links a demo page where you can see Marked in action, and the documentation site itself is rendered using Marked.What are similar projects?turndown, markdown-it, tui.editor, editor.md, liteparse, react-markdown, virtual-dom, million
turndown, markdown-it, tui.editor, editor.md, liteparse, react-markdown, virtual-dom, millionWhich topics is it in?gfm, commonmark, speed, parser, rendering, compiler, javascript-library, browser, command-line, developers, hacktoberfest, html
gfm, commonmark, speed, parser, rendering, compiler, javascript-library, browser, command-line, developers, hacktoberfest, html