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
Jetons d’accès affinés pour « Render a Markdown document »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis ne nécessite aucune autorisation.
Ce point de terminaison peut être utilisé sans authentification ou si seules les ressources publiques sont demandées.
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 »
Si vous accédez à GitHub à GHE.com, remplacez api.github.com
par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com
.
Exemple de requête
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.
Jetons d’accès affinés pour « Render a Markdown document in raw mode »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis 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 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 »
Si vous accédez à GitHub à GHE.com, remplacez api.github.com
par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com
.
Exemples de requête
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>"