Skip to main content
The REST API is now versioned. For more information, see "About API versioning."

Markdown

La API de Lenguaje de marcado te permite generar un documento de lenguaje de marcado como una página HTML o como texto sin procesar.

Render a Markdown document

Works with GitHub Apps

Parameters

Headers
Name, Type, Description
acceptstring

Setting to application/vnd.github+json is recommended.

Body parameters
Name, Type, Description
textstringRequired

The Markdown text to render in HTML.

modestring

The rendering mode.

Default: markdown

Can be one of: markdown, gfm

contextstring

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

Status codeDescription
200

OK

304

Not modified

Code samples

post/markdown
curl \ -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

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

Status codeDescription
200

OK

304

Not modified

Code samples

post/markdown/raw
curl \ -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>"