Puntos de conexión de la API de REST para 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
Tokens de acceso específicos para "Render a Markdown document"
Este punto de conexión funciona con los siguientes tipos de token:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token no requiere ningún permiso.
Parámetros para "Render a Markdown document"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
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"
Ejemplo de solicitud
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/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.
Tokens de acceso específicos para "Render a Markdown document in raw mode"
Este punto de conexión funciona con los siguientes tipos de token:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token no requiere ningún permiso.
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"
Ejemplos de solicitud
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/markdown/raw \
-d '{"text":"Hello **world**"}'
Example response
Status: 200
"<p>Hello <strong>world</strong></p>"