Pontos de extremidade da API REST para Markdown
Use a API REST para renderizar um documento de markdown como uma página HTML ou como um texto bruto.
Render a Markdown document
Tokens de acesso refinados para "Render a Markdown document"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinaado não requer permissões.
Esse ponto de extremidade pode ser usado sem autenticação se apenas recursos públicos forem solicitados.
Parâmetros para "Render a Markdown document"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
text string ObrigatórioThe Markdown text to render in HTML. |
mode string The rendering mode. Padrão: Pode ser um dos: |
context string The repository context to use when creating references in |
Códigos de status de resposta HTTP para "Render a Markdown document"
Código de status | Descrição |
---|---|
200 | OK |
304 | Not modified |
Exemplos de código para "Render a Markdown document"
Exemplo de solicitação
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 acesso refinados para "Render a Markdown document in raw mode"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinaado não requer permissões.
Esse ponto de extremidade pode ser usado sem autenticação se apenas recursos públicos forem solicitados.
Códigos de status de resposta HTTP para "Render a Markdown document in raw mode"
Código de status | Descrição |
---|---|
200 | OK |
304 | Not modified |
Exemplos de código para "Render a Markdown document in raw mode"
Exemplos de solicitação
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>"