Esta versão do GitHub Enterprise foi descontinuada em 2022-06-03. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, melhorar a segurança e novos recursos, upgrade to the latest version of GitHub Enterprise. Para ajuda com a atualização, contact GitHub Enterprise support.
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 |
---|
Nome, Tipo, Descrição |
accept stringSetting to |
Body parameters |
Nome, Tipo, Descrição |
text stringObrigatórioThe Markdown text to render in HTML. |
mode stringThe rendering mode. Can be either Padrão: Pode ser uma das ações a seguir: |
context stringThe repository context to use when creating references in |
HTTP response status codes
Status code | Descrição |
---|---|
200 | OK |
304 | Not modified |
Amostras de código
curl \
-X POST \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <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.
HTTP response status codes
Status code | Descrição |
---|---|
200 | OK |
304 | Not modified |