Pontos de extremidade da API REST para Markdown

Use a API REST para renderizar um documento de markdown como uma página HTML ou como um texto bruto.

Render a Markdown document

Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as issues:read or pull_requests:read.

Tokens de acesso granular para "Render a Markdown document"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinado deve ter os seguintes conjuntos de permissões:

"Contents" repository permissions (read)

Esse endpoint pode ser usado sem autenticação ou permissões mencionadas acima, se apenas recursos públicos forem solicitados.

Parâmetros para "Render a Markdown document"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros do corpo
Nome, Tipo, Descrição
`text` string Obrigatório The Markdown text to render in HTML.
`mode` string The rendering mode. Padrão: `markdown` Pode ser um dos: `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.

Códigos de status de resposta HTTP para "Render a Markdown document"

Código de status	Descrição
`200`	OK
`304`	Not modified

Exemplos de código para "Render a Markdown document"

Exemplo de solicitação

post/markdown

curl -L \
  -X POST \
  -H "Accept: text/html" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/markdown \
  -d '{"text":"Hello **world**"}'

Example response

Status: 200

"Hello world"

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.

Tokens de acesso granular para "Render a Markdown document in raw mode"

Este endpoint funciona com os seguintes tipos de token granulares:

O token refinaado não requer permissões.

Este endpoint pode ser usado sem autenticação caso sejam solicitados apenas recursos públicos.

Códigos de status de resposta HTTP para "Render a Markdown document in raw mode"

Código de status	Descrição
`200`	OK
`304`	Not modified

Exemplos de código para "Render a Markdown document in raw mode"

Exemplos de solicitação

Select the example type

post/markdown/raw

curl -L \
  -X POST \
  -H "Accept: text/html" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/markdown/raw \
  -d '{"text":"Hello **world**"}'

Example response

Status: 200

"Hello world"