我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

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

文章版本: Enterprise Server 2.18

Markdown

本文内容

Did this doc help you?

post /markdown

参数

Name Type In Description
accept string header

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

text string body

Required. The Markdown text to render in HTML. Markdown content must be 400 KB or less.

mode string body

The rendering mode. Can be either:
* markdown to render a document in plain Markdown, just like README.md files are rendered.
* gfm to render a document in GitHub Flavored Markdown, which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.

Default: markdown
context string body

The repository context to use when creating references in gfm mode. Omit this parameter when using markdown mode.

代码示例

Shell
curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  https://{hostname}/markdown \
  -d '{"text":"text"}'
JavaScript (@octokit/core.js)
await octokit.request('POST /markdown', {
  text: 'text'
})

Response

Status: 200 OK

Notes


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

参数

Name Type In Description
accept string header

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

content-type string header

Setting content-type header is required for this endpoint

代码示例

Shell
curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  https://{hostname}/markdown/raw \
  -d '{"data":"data"}'
JavaScript (@octokit/core.js)
await octokit.request('POST /markdown/raw', {
  data: 'data',
  headers: {
    'content-type': 'text/plain; charset=utf-8'
  }
})

Response

Status: 200 OK

Notes


Did this doc help you?

问问别人

找不到要找的内容?

联系我们