Cette version de GitHub Enterprise Server n'est plus disponible depuis le 2024-03-26. Aucune publication de correctifs n’est effectuée, même pour les problèmes de sécurité critiques. Pour de meilleures performances, une sécurité améliorée et de nouvelles fonctionnalités, effectuez une mise à niveau vers la dernière version de GitHub Enterprise. Pour obtenir de l’aide sur la mise à niveau, contactez le support GitHub Enterprise.
Points de terminaison d’API REST pour Markdown
Utilisez l’API REST pour afficher un document Markdown sous forme de page HTML ou de texte brut.
Render a Markdown document
Paramètres pour « Render a Markdown document »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
text string ObligatoireThe Markdown text to render in HTML. |
mode string The rendering mode. Default: Peut être: |
context string The repository context to use when creating references in |
Codes d’état de la réponse HTTP pour « Render a Markdown document »
Code d’état | Description |
---|---|
200 | OK |
304 | Not modified |
Exemples de code pour « Render a Markdown document »
Exemple de requête
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.
Codes d’état de la réponse HTTP pour « Render a Markdown document in raw mode »
Code d’état | Description |
---|---|
200 | OK |
304 | Not modified |
Exemples de code pour « Render a Markdown document in raw mode »
Exemples de requête
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>"