Markdown

Renders html from Markdown text

Constructor

new Markdown(auth, apiBaseopt)

construct a Markdown

Parameters:

Name	Type	Attributes	Description
`auth`	Requestable.auth		the credentials to authenticate to GitHub
`apiBase`	string	<optional>	the base Github API URL

Source:

Markdown.js, line 13

Methods

render(options, cbopt) → {Promise}

Render html from Markdown text.

Parameters:

Name Type Attributes Description

options

Object

conversion options

Properties

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

will receive the converted html

Source:

Markdown.js, line 34

See:

https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document

Returns:

the promise for the http request

Type: Promise

pFad - Phonifier reborn

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Markdown

Constructor

new Markdown(auth, apiBaseopt)

Parameters:

Methods

render(options, cbopt) → {Promise}

Parameters:

Properties

Returns:

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.