Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Esta versão do GitHub Enterprise será descontinuada em Esta versão do GitHub Enterprise foi descontinuada em 2020-08-20. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, melhorar a segurança e novos recursos, upgrade to the latest version of GitHub Enterprise. Para ajuda com a atualização, contact GitHub Enterprise support.

Versão do artigo: Enterprise Server 2.18

markdown

Neste artigo

Did this doc help you?

post /markdown

Parâmetros

Name Type In Description
accept string header

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

text string body

Required. The Markdown text to render in HTML. Markdown content must be 400 KB or less.

mode string body

The rendering mode. Can be either:
* markdown to render a document in plain Markdown, just like README.md files are rendered.
* gfm to render a document in GitHub Flavored Markdown, which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.

Default: markdown
context string body

The repository context to use when creating references in gfm mode. Omit this parameter when using markdown mode.

Amostras de código

Shell
curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  https://{hostname}/markdown \
  -d '{"text":"text"}'
JavaScript (@octokit/core.js)
await octokit.request('POST /markdown', {
  text: 'text'
})

Response

Status: 200 OK

Notes


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.

post /markdown/raw

Parâmetros

Name Type In Description
accept string header

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

content-type string header

Setting content-type header is required for this endpoint

Amostras de código

Shell
curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  https://{hostname}/markdown/raw \
  -d '{"data":"data"}'
JavaScript (@octokit/core.js)
await octokit.request('POST /markdown/raw', {
  data: 'data',
  headers: {
    'content-type': 'text/plain; charset=utf-8'
  }
})

Response

Status: 200 OK

Notes


Did this doc help you?

Pergunte a uma pessoa

Não consegue encontrar o que procura?

Entrar em contato