Esta versión de GitHub Enterprise se discontinuó el 2023-03-15. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener rendimiento mejorado, seguridad mejorada y nuevas características, actualice a la versión más reciente de GitHub Enterprise. Para obtener ayuda con la actualización, póngase en contacto con el soporte técnico de GitHub Enterprise.
Markdown
Utiliza la API de REST para representar un documento de lenguaje de marcado como una página HTML o como texto sin procesar.
Render a Markdown document
Parámetros para "Render a Markdown document"
Encabezados |
---|
Nombre, Tipo, Descripción |
accept string Setting to |
Parámetros del cuerpo |
Nombre, Tipo, Descripción |
text string RequeridoThe Markdown text to render in HTML. |
mode string The rendering mode. Valor predeterminado: Puede ser uno de los siguientes: |
context string The repository context to use when creating references in |
Códigos de estado de respuesta HTTP para "Render a Markdown document"
status code | Descripción |
---|---|
200 | OK |
304 | Not modified |
Ejemplos de código para "Render a Markdown document"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/markdown \
-d '{"text":"Hello **world**"}'
Example response
Status: 200
"<p>Hello <strong>world</strong></p>"
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.
Códigos de estado de respuesta HTTP para "Render a Markdown document in raw mode"
status code | Descripción |
---|---|
200 | OK |
304 | Not modified |
Ejemplos de código para "Render a Markdown document in raw mode"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/markdown/raw \
-d '{"text":"Hello **world**"}'
Example response
Status: 200
"<p>Hello <strong>world</strong></p>"