Markdown
Use the REST API to render a markdown document as an HTML page or as raw text.
Render a Markdown document
Parameters for "Render a Markdown document"
Headers |
---|
Name, Type, Description |
accept string Setting to |
Body parameters |
Name, Type, Description |
text string RequiredThe Markdown text to render in HTML. |
mode string The rendering mode. Default: Can be one of: |
context string The repository context to use when creating references in |
HTTP response status codes for "Render a Markdown document"
Status code | Description |
---|---|
200 | OK |
304 | Not modified |
Code samples for "Render a Markdown document"
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.
HTTP response status codes for "Render a Markdown document in raw mode"
Status code | Description |
---|---|
200 | OK |
304 | Not modified |
Code samples for "Render a Markdown document in raw mode"
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>"