此版本的 GitHub Enterprise 已停止服务 2023-01-18. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持。
Markdown
使用 REST API 渲染 markdown 文档作为 HTML 页面或原始文本。
Render a Markdown document
Parameters
Headers |
---|
名称, Type, 说明 |
accept stringSetting to |
Body parameters |
名称, Type, 说明 |
text stringRequiredThe Markdown text to render in HTML. |
mode stringThe rendering mode. Default: Can be one of: |
context stringThe repository context to use when creating references in |
HTTP response status codes
Status code | 说明 |
---|---|
200 | OK |
304 | Not modified |
Code samples
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
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 response status codes
Status code | 说明 |
---|---|
200 | OK |
304 | Not modified |
Code samples
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>"