post /markdownParameters
| Name | Type | In | Description |
|---|---|---|---|
accept |
string | header |
Setting to |
text |
string | body |
Required. The Markdown text to render in HTML. Markdown content must be 400 KB or less. |
mode |
string | body |
The rendering mode. Can be either: markdown
|
context |
string | body |
The repository context to use when creating references in |
Code samples
Shell
curl \
-X POST \
-H "Accept: application/vnd.github.v3+json" \
https://{hostname}/markdown \
-d '{"text":"text"}'
JavaScript (@octokit/core.js)
await octokit.request('POST /markdown', {
text: 'text'
})
Response
Status: 200 OKNotes
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.
post /markdown/rawParameters
| Name | Type | In | Description |
|---|---|---|---|
accept |
string | header |
Setting to |
content-type |
string | header |
Setting content-type header is required for this endpoint |
Code samples
Shell
curl \
-X POST \
-H "Accept: application/vnd.github.v3+json" \
https://{hostname}/markdown/raw \
-d '{"data":"data"}'
JavaScript (@octokit/core.js)
await octokit.request('POST /markdown/raw', {
data: 'data',
headers: {
'content-type': 'text/plain; charset=utf-8'
}
})
Response
Status: 200 OK