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

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.

mode string body

The rendering mode.

Default: markdown
context string body

The repository context to use when creating references in gfm mode.

Ejemplos de código

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

Response

Status: 200 OK

Not modified

Status: 304 Not Modified

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

Ejemplos de código

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

Response

Status: 200 OK

Not modified

Status: 304 Not Modified

Notes


¿Te ayudó este documento?

Política de privacidad

¡Ayúdanos a hacer geniales estos documentos!

Todos los documentos de GitHub son de código abierto. ¿Notas algo que esté mal o que no sea claro? Emite una solicitud de cambios.

Haz una contribución

O, aprende cómo contribuir.