Skip to main content
Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos.

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

Funciona con GitHub Apps

Parámetros

Encabezados
Nombre, Tipo, Descripción
acceptstring

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

Parámetros de cuerpo
Nombre, Tipo, Descripción
textstringRequerido

The Markdown text to render in HTML.

modestring

The rendering mode. Can be either markdown or gfm.

Predeterminado: markdown

Puede ser una de las siguientes: 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.

Códigos de estado de respuesta HTTP

Código de estadoDescripción
200

OK

304

Not modified

Ejemplos de código

post/markdown
curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ http(s)://HOSTNAME/api/v3/markdown

Response

Status: 200

Render a Markdown document in raw mode

Funciona con 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.

Códigos de estado de respuesta HTTP

Código de estadoDescripción
200

OK

304

Not modified