Skip to main content

此版本的 GitHub Enterprise 已停止服务 2022-06-03. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

Markdown

Markdown API 可让您渲染 markdown 文档作为 HTML 页面或原始文本。

Render a Markdown document

参数

� �头
名称, 类型, 描述
acceptstring

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

正文参数
名称, 类型, 描述
textstring必选

The Markdown text to render in HTML.

modestring

The rendering mode. Can be either markdown or gfm.

默认值: 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.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/markdown

Response

Status: 200

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

状态代� �描述
200

OK

304

Not modified