Skip to main content

markdown

A API de Markdown permite que você interprete um documento de markdown como uma página HTML ou como texto não processado.

Render a Markdown document

Works with GitHub Apps

Parâmetros

Headers
Nome, Tipo, Descrição
acceptstring

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

Body parameters
Nome, Tipo, Descrição
textstringObrigatório

The Markdown text to render in HTML.

modestring

The rendering mode. Can be either markdown or gfm.

Padrão: markdown

Pode ser uma das ações a seguir: 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 codeDescrição
200

OK

304

Not modified

Amostras de código

post/markdown
curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/markdown

Response

Status: 200

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 codeDescrição
200

OK

304

Not modified