mirror of https://github.com/markedjs/marked synced 2024-11-22 17:37:24 +00:00

Go to file

Tony Brix 411fcfe9ce Update supported spec versions		2019-05-23 15:13:46 -05:00
.github	Add a "why" to feature request	2018-05-11 09:34:11 -04:00
bin	space-before-function-paren never	2019-05-03 20:59:44 -05:00
docs	Update supported spec versions	2019-05-23 15:13:46 -05:00
lib	conflict fix 2	2019-05-21 18:42:00 -05:00
man	update man pages	2019-03-12 09:07:47 -05:00
test	move files	2019-05-22 11:43:31 -05:00
.editorconfig	style	2018-04-05 11:36:07 -04:00
.eslintignore	ignore *.min.js files	2018-03-29 13:00:33 -05:00
.eslintrc.json	use "sourceType": "script" with standard	2019-05-03 20:59:45 -05:00
.gitattributes	Fix GitHub language via override	2018-02-15 11:28:53 -05:00
.gitignore	Ignore DS_Store on macos	2018-03-23 07:50:42 -04:00
.travis.yml	Update .travis.yml	2018-10-28 18:33:43 -04:00
bower.json	Fix urls to markedjs	2018-03-03 14:20:24 -05:00
component.json	Fix urls to markedjs	2018-03-03 14:20:24 -05:00
index.js	index	2011-08-14 00:07:51 -05:00
jasmine.json	abstract htmldiffer	2019-03-13 08:50:11 -05:00
LICENSE.md	Move license back to root dir	2018-10-16 21:16:43 -04:00
Makefile	generate textual manpage	2018-01-09 15:07:01 +01:00
marked.min.js	🗜️ minify [skip ci]	2019-05-22 22:16:06 +00:00
package-lock.json	remove glob-to-regex dependency	2019-05-03 20:59:44 -05:00
package.json	remove glob-to-regex dependency	2019-05-03 20:59:44 -05:00
README.md	Merge pull request #1420 from markedjs/snyk-badge	2019-02-19 13:27:11 -06:00

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 💯

Installation

CLI: npm install -g marked

In-browser: npm install marked

Usage

Warning: 🚨 Marked does not sanitize the output HTML by default 🚨

CLI

$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>

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