post /markdown参数
| Name | Type | In | Description |
|---|---|---|---|
accept | string | header | Setting to |
text | string | body | Required. The Markdown text to render in HTML. |
mode | string | body | The rendering mode. Default:markdown |
context | string | body | The repository context to use when creating references in |
代码示例
Shell
curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/markdown \ -d '{"text":"text"}'JavaScript (@octokit/core.js)
await octokit.request('POST /markdown', { text: 'text' }) Response
Status: 200 OKNot modified
Status: 304 Not ModifiedNotes
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/raw代码示例
Shell
curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ http(s)://{hostname}/api/v3/markdown/rawJavaScript (@octokit/core.js)
await octokit.request('POST /markdown/raw') Response
Status: 200 OKNot modified
Status: 304 Not Modified