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

Go to file

Steven bf563cd5ca Fix link to license		2018-10-16 21:22:16 -04:00
.github	Add a "why" to feature request	2018-05-11 09:34:11 -04:00
bin	Merge branch 'master' into fixes_992	2018-05-07 16:26:05 +02:00
docs	Fix link to license	2018-10-16 21:22:16 -04:00
lib	Add missing semicolons	2018-09-23 20:27:20 -04:00
man	fix man	2018-04-05 14:38:56 -05:00
test	Add missing semicolons to tests	2018-09-23 20:56:38 -04: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	Add eslint rule semicolons required	2018-09-23 20:27:39 -04: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
.npmignore	Move existing docs to /docs dir	2018-03-11 17:16:48 -04:00
.travis.yml	Change travis clone depth from 5 to 3	2018-05-13 15:15:59 -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	add jasmine tests	2018-03-03 01:09:09 -06: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]	2018-09-20 12:49:24 +00:00
package-lock.json	change version to 0.5.1	2018-09-25 13:44:47 -04:00
package.json	change version to 0.5.1	2018-09-25 13:44:47 -04:00
README.md	Fix link to david-dm	2018-09-10 13:56:03 -04: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 --save

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>