Markdown

Markdown

Renders html from Markdown text

Constructor

new Markdown(auth, apiBaseopt) → {Promise}

construct a Markdown

Source:
Parameters:
Name Type Attributes Description
auth Requestable.auth

the credentials to authenticate to GitHub

apiBase string <optional>

the base Github API URL

Returns:
Type:
Promise
  • the promise for the http request

Methods

render(options, cbopt) → {Promise}

Render html from Markdown text.

Source:
See:
Parameters:
Name Type Attributes Description
options Object

conversion options

Name Type Attributes Default Description
text string <optional>

the markdown text to convert

mode string <optional>
markdown

can be either markdown or gfm

context string <optional>

repository name if mode is gfm

cb Requestable.callback <optional>

will receive the converted html

Returns:
Type:
Promise
  • the promise for the http request