Markdown

Use the REST API to render a markdown document as an HTML page or as raw text.

Render a Markdown document

Parameters for "Render a Markdown document"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Body parameters
Name, Type, Description
`text` string Required The Markdown text to render in HTML.
`mode` string The rendering mode. Default: `markdown` Can be one of: `markdown`, `gfm`
`context` string 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.

HTTP response status codes for "Render a Markdown document"

Status code	Description
`200`	OK
`304`	Not modified

Code samples for "Render a Markdown document"

post/markdown

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/markdown \
  -d '{"text":"Hello **world**"}'

Example response

Status: 200

"Hello world"

Render a Markdown document in raw mode

Works with GitHub Apps

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.

HTTP response status codes for "Render a Markdown document in raw mode"

Status code	Description
`200`	OK
`304`	Not modified

Code samples for "Render a Markdown document in raw mode"

Select the example type

post/markdown/raw

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/markdown/raw \
  -d '{"text":"Hello **world**"}'

Example response

Status: 200

"Hello world"