Skip to content

ahmadnassri/node-marked-promise

Repository files navigation

Marked Promise

Promise version of marked

license release semantic

Install

npm install marked-promise

API

marked(markdown [, options])

pattern: String options: Object Return: Object ([Promise])

When it finishes, it will be fulfilled with an String of the HTML content as its first argument.

When it fails to read the files, it will be rejected with an error as its first argument.

marked('I am using __markdown__.')
  .then(function(contents) {
    contents; //=> <p>I am using <strong>markdown</strong>.</p>\n
  });

options

The option object will be directly passed to marked.


Author: Ahmad Nassri • Twitter: @AhmadNassri