Esta versión de GitHub Enterprise se discontinuó el 2022-10-12. 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
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
Parámetros
Headers |
---|
Name, Type, Description |
accept stringSetting to |
Body parameters |
Name, Type, Description |
text stringRequiredThe Markdown text to render in HTML. |
mode stringThe rendering mode. Default: Can be one of: |
context stringThe repository context to use when creating references in |
Códigos de estado de respuesta HTTP
status code | Descripción |
---|---|
200 | OK |
304 | Not modified |
Ejemplos de código
curl \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/markdown
Response
Status: 200
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
status code | Descripción |
---|---|
200 | OK |
304 | Not modified |