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:
Methods
render(options, cbopt) → {Promise}
Render html from Markdown text.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | conversion options Properties
|
|||||||||||||||||||||
cb |
Requestable.callback |
<optional> |
will receive the converted html |
- Source:
- See:
Returns:
- the promise for the http request
- Type
- Promise