Markdown

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

Render a Markdown document

参数

标头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github+json` is recommended.
正文参数
名称, 类型, 描述
`text`string必选 The Markdown text to render in HTML.
`mode`string The rendering mode. Can be either `markdown` or `gfm`. 默认值: `markdown` 可以是以下其中之一: `markdown`, `gfm`
`context`string 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: token <TOKEN>" \
  https://api.github.com/markdown

Response

Status: 200

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