mirror of https://github.com/markedjs/marked
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
dependabot[bot]
5203b44da9
|
6 hours ago | |
|---|---|---|
| .devcontainer | 5 months ago | |
| .github | 4 weeks ago | |
| api | 7 months ago | |
| bin | 1 year ago | |
| docs | 4 weeks ago | |
| lib | 3 days ago | |
| man | 2 years ago | |
| src | 3 days ago | |
| test | 3 days ago | |
| .editorconfig | 5 years ago | |
| .eslintignore | 4 years ago | |
| .eslintrc.json | 3 years ago | |
| .gitattributes | 2 years ago | |
| .gitignore | 3 years ago | |
| .releaserc.json | 2 years ago | |
| LICENSE.md | 3 years ago | |
| Makefile | 2 years ago | |
| README.md | 9 months ago | |
| SECURITY.md | 3 years ago | |
| bower.json | 2 years ago | |
| build-docs.js | 1 year ago | |
| component.json | 2 years ago | |
| jasmine.json | 2 years ago | |
| marked.min.js | 3 days ago | |
| package-lock.json | 6 hours ago | |
| package.json | 6 hours ago | |
| rollup.config.js | 5 months ago | |
| vercel.json | 3 years ago | |
README.md
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 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)