Cette version de GitHub Enterprise Server ne sera plus disponible le 2026-08-25. Les versions abandonnées ne sont pas prises en charge. 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 dans GitHub Enterprise Server, consultez Overview du processus de mise à niveau. Pour obtenir de l’aide sur la mise à niveau, GitHub Support Entreprise.

L’API REST est maintenant versionnée. Pour plus d’informations, consultez « À propos des versions de l’API ».

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

Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as issues:read or pull_requests:read.

Jetons d'accès granulaires pour «Render a Markdown document»

Ce point de terminaison fonctionne avec les types de tokens à granularité fine suivants:

Le token à granularité fine doit disposer de l’ensemble d’autorisations suivant:

  • "Contents" repository permissions (read)

Ce point de terminaison peut être utilisé sans authentification ou sans les autorisations mentionnées ci-dessus si seules les ressources publiques sont demandées.

Paramètres pour «Render a Markdown document »

En-têtes
accept string

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

Paramètres du corps
text string Requis

The Markdown text to render in HTML.

mode string

The rendering mode.

Par défaut: markdown

Peut être l'un des: markdown, gfm

context string

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.

Codes d’état de réponse HTTP pour «Render a Markdown document »

Code de statutDescription
200

OK

304

Not modified

Exemples de code pour «Render a Markdown document »

Exemple de requête

post/markdown
curl -L \ -X POST \ -H "Accept: text/html" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ 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.

Jetons d'accès granulaires pour «Render a Markdown document in raw mode»

Ce point de terminaison fonctionne avec les types de tokens à granularité fine suivants:

Le token à granularité fine ne nécessite aucune autorisation.

Ce point de terminaison peut être utilisé sans authentification ou si seules les ressources publiques sont demandées.

Codes d’état de réponse HTTP pour «Render a Markdown document in raw mode »

Code de statutDescription
200

OK

304

Not modified

Exemples de code pour «Render a Markdown document in raw mode »

Exemples de requête

post/markdown/raw
curl -L \ -X POST \ -H "Accept: text/html" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/markdown/raw \ -d '{"text":"Hello **world**"}'

Example response

Status: 200
"<p>Hello <strong>world</strong></p>"