Markdown 的 REST API 终结点
使用 REST API 渲染 markdown 文档作为 HTML 页面或原始文本。
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.
“Render a Markdown document”的细粒度访问令牌
此端点支持以下精细令牌类型:
精细令牌必须具有以下权限集:
- "Contents" repository permissions (read)
如果仅请求公共资源，则无需身份验证或上述权限即可使用此终结点。
“Render a Markdown document”的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
text string 必须The Markdown text to render in HTML. |
mode string The rendering mode. 默认: 可以是以下选项之一: |
context string The repository context to use when creating references in |
“Render a Markdown document”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
304 | Not modified |
“Render a Markdown document”的示例代码
请求示例
curl -L \
-X POST \
-H "Accept: text/html" \
-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.
“Render a Markdown document in raw mode”的细粒度访问令牌
此端点支持以下精细令牌类型:
精细令牌不需要任何权限。
如果仅请求公共资源，则无需身份验证即可使用此终结点。
“Render a Markdown document in raw mode”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
304 | Not modified |
“Render a Markdown document in raw mode”的示例代码
请求示例
curl -L \
-X POST \
-H "Accept: text/html" \
-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>"