Skip to main content
我们经常发布文档更新,此页面的翻译可能仍在进行中。 有关最新信息,请访问英语文档

Markdown

使用 REST API 渲染 markdown 文档作为 HTML 页面或原始文本。

Render a Markdown document

适用于 GitHub Apps

参数

标头
名称, 类型, 说明
acceptstring

Setting to application/vnd.github+json is recommended.

正文参数
名称, 类型, 说明
textstring必须

The Markdown text to render in HTML.

modestring

The rendering mode.

默认: markdown

可以是以下选项之一: markdown, gfm

contextstring

The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

HTTP 响应状态代码

状态代码说明
200

OK

304

Not modified

代码示例

post/markdown
curl \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/markdown \ -d '{"text":"Hello **world**"}'

Example response

Status: 200
"<p>Hello <strong>world</strong></p>"

Render a Markdown document in raw mode

适用于 GitHub Apps

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 响应状态代码

状态代码说明
200

OK

304

Not modified

代码示例

post/markdown/raw
curl \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/markdown/raw \ -d '{"text":"Hello **world**"}'

Example response

Status: 200
"<p>Hello <strong>world</strong></p>"