Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

wzq0621/marked

Repository files navigation

Marked

npm gzip size install size downloads dep dev dep travis

  • ⚡ 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:

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>

License

Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)

About

A markdown parser and compiler. Built for speed.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

Contributors

Languages

  • JavaScript 99.4%
  • Makefile 0.6%

AltStyle によって変換されたページ (->オリジナル) /