Markdown

Render a Markdown document

post /markdown

Parameters

Name	Type	In	Description
accept	string	header	Setting to application/vnd.github.v3+json is recommended.
text	string	body	Required. The Markdown text to render in HTML.
mode	string	body	The rendering mode. Can be either markdown or gfm. Default: markdown
context	string	body	The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

Code samples

Shell

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/markdown \
  -d '{"text":"text"}'

JavaScript (@octokit/core.js)

await octokit.request('POST /markdown', {
  text: 'text'
})

Response

Status: 200 OK

Not modified

Status: 304 Not Modified

Notes

• Works with GitHub Apps

Render a Markdown document in raw mode

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.

post /markdown/raw

Code samples

Shell

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/markdown/raw

JavaScript (@octokit/core.js)

await octokit.request('POST /markdown/raw')

Response

Status: 200 OK

Not modified

Status: 304 Not Modified

Notes

• Works with GitHub Apps