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

Go to file

Tony Brix ae5315891a fix build		2020-04-01 10:29:21 -05:00
.github	fix build	2020-04-01 10:29:21 -05:00
bin	marked --help	2019-12-26 16:09:02 -03:00
docs	Update docs/USING_ADVANCED.md	2020-03-18 22:28:21 -04:00
lib	build	2020-03-22 00:34:59 -05:00
man	remove tables option	2019-07-02 00:23:57 -05:00
src	simplify tag regex	2020-03-21 22:08:29 -05:00
test	add html test to heading ids	2020-03-20 09:05:53 -05:00
.editorconfig	style	2018-04-05 11:36:07 -04:00
.eslintignore	fix eslint config	2019-11-05 15:31:11 -06:00
.eslintrc.json	fix eslint config	2019-11-05 15:31:11 -06: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
.nowignore	Add .nowignore	2020-02-05 11:48:35 -05: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	build	2020-03-22 00:34:59 -05:00
now.json	Cleanup now.json	2020-02-05 10:31:45 -05:00
package-lock.json	0.8.2	2020-03-22 00:35:00 -05:00
package.json	0.8.2	2020-03-22 00:35:00 -05:00
README.md	update readme badge	2020-04-01 00:53:50 -05:00
rollup.config.esm.js	Update copyright year	2019-11-11 11:24:05 -06:00
rollup.config.js	Use Babel's loose mode for shorted & more performant code	2019-12-04 17:29:13 +01:00
SECURITY.md	add links	2019-05-23 15:25:01 -05: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. Please use a sanitize library, like DOMPurify (recommended), sanitize-html or insane on the output HTML! 🚨

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>