Go to file
Rich Trott 04e04b10d4 fix issues link references and prototypes
Link with names that clashed with properties inherited from the
Object prototype (such as "constructor") were not expanding. This fixes
this issue.

Before this change, markdown of this form...:

    Link: [constructor][].

    [constructor]: https://example.org/

...resulted in HTML output of this form:

    <p>Link: [constructor][].</p>

With this change, it now renders as expected:

    <p>Link: <a href="https://example.org/">constructor</a>.</p>
2018-06-28 13:41:43 -07: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 Update USING_ADVANCED.md 2018-05-24 12:08:07 -06:00
lib fix issues link references and prototypes 2018-06-28 13:41:43 -07:00
man fix man 2018-04-05 14:38:56 -05:00
test fix issues link references and prototypes 2018-06-28 13:41:43 -07: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 jasmine tests 2018-03-03 01:09:09 -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
.npmignore Move existing docs to /docs dir 2018-03-11 17:16:48 -04:00
.travis.yml move security scan to the end 2018-05-07 14:07:14 -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
jasmine.json add jasmine tests 2018-03-03 01:09:09 -06:00
LICENSE.md Beginning RELEASE refinement 2018-02-25 17:58:24 -05:00
Makefile generate textual manpage 2018-01-09 15:07:01 +01:00
marked.min.js 🗜️ minify [skip ci] 2018-06-12 16:12:02 +00:00
package-lock.json 0.4.0 2018-05-18 17:12:18 -04:00
package.json 0.4.0 2018-05-18 17:12:18 -04:00
README.md Add badges to README 2018-04-15 18:29:57 -04:00

Marked

npm gzip size install size downloads 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 💯

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>
</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)