octokit.markdown.render({text,});
| name | required | description |
|---|---|---|
| text | yes | The Markdown text to render in HTML. |
| mode | no | The rendering mode. |
| context | no | The repository context to use when creating references in |
See also: GitHub Developer Guide documentation.
You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.
octokit.markdown.renderRaw({data,});
| name | required | description |
|---|---|---|
| data | yes | raw markdown text |
See also: GitHub Developer Guide documentation.