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
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.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Contents" repository permissions (read)
allows_public_read_access
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 |
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
304 | Not modified |
code_samples
request_example
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.
fine_grained_access
works_with_fine_grained_tokens:
no_permission_sets
allows_public_read_access_no_permissions
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
304 | Not modified |
code_samples
request_examples
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>"