This version of GitHub Enterprise was discontinued on 2022-06-03. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.
Markdown
The Markdown API enables you to render a markdown document as an HTML page or as raw text.
Render a Markdown document
Parameters
| Headers |
|---|
| Name, Type, Description |
acceptstringSetting to |
| Body parameters |
| Name, Type, Description |
textstringRequiredThe Markdown text to render in HTML. |
modestringThe rendering mode. Can be either Default: Can be one of: |
contextstringThe repository context to use when creating references in |
HTTP response status codes
| Status code | Description |
|---|---|
200 | OK |
304 | Not modified |
Code samples
curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/markdownResponse
Status: 200Render 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 | Description |
|---|---|
200 | OK |
304 | Not modified |