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.
|
5 months ago | |
---|---|---|
.. | ||
bin | 5 months ago | |
lib | 5 months ago | |
man | 5 months ago | |
www | 5 months ago | |
.editorconfig | 5 months ago | |
.eslintrc.json | 5 months ago | |
.travis.yml | 5 months ago | |
LICENSE.md | 5 months ago | |
Makefile | 5 months ago | |
README.md | 5 months ago | |
bower.json | 5 months ago | |
component.json | 5 months ago | |
index.js | 5 months ago | |
jasmine.json | 5 months ago | |
marked.min.js | 5 months ago | |
package.json | 5 months ago |
README.md
Marked
Marked is
- built for speed.
- a low-level markdown compiler that allows frequent parsing of large chunks of markdown without caching or blocking for long periods of time.
- light-weight while implementing all markdown features from the supported flavors & specifications.
- available as a command line interface (CLI) and running in client- or server-side JavaScript projects.
Installation
CLI: npm install -g marked
In-browser: npm install marked --save
Usage
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>
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
</head>
<body>
<div id="content"></div>
<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)