Esta versão do GitHub Enterprise foi descontinuada em 2022-10-12. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.
Markdown
A API de Markdown permite que você interprete um documento de markdown como uma página HTML ou como texto não processado.
Render a Markdown document
Parâmetros
Headers |
---|
Name, Type, Description |
accept stringSetting to |
Body parameters |
Name, Type, Description |
text stringRequiredThe Markdown text to render in HTML. |
mode stringThe rendering mode. Default: Can be one of: |
context stringThe repository context to use when creating references in |
Códigos de status de resposta HTTP
Código de status | Descrição |
---|---|
200 | OK |
304 | Not modified |
Exemplos de código
curl \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/markdown
Response
Status: 200
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.
Códigos de status de resposta HTTP
Código de status | Descrição |
---|---|
200 | OK |
304 | Not modified |