REST API endpoints for Markdown - GitHub Docs (original) (raw)

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

Render a Markdown document

Fine-grained access tokens for "Render a Markdown document"

This endpoint works with the following fine-grained token types:

The fine-grained token does not require any permissions.

This endpoint can be used without authentication if only public resources are requested.

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 RequiredThe Markdown text to render in HTML.
mode string The rendering mode.Default: markdownCan 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"

Request example

curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/markdown \ -d '{"text":"Hello **world**"}'

Example response

Status: 200

"<p>Hello <strong>world</strong></p>"

Render a Markdown document in raw mode

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

Request examples

curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/markdown/raw \ -d '{"text":"Hello **world**"}'

Example response

Status: 200

"<p>Hello <strong>world</strong></p>"