使用 REST API 将 Markdown 文档呈现为 HTML 页面或纯文本。
此端点适用于以下细粒度令牌类型:
细粒度令牌不需要任何权限。
如果仅请求公共资源，则可以在没有身份验证的情况下使用此端点。
accept
建议设置为 application/vnd.github+json。
application/vnd.github+json
text
要以 HTML 呈现的 Markdown 文本。
mode
渲染模式。
默认： markdown
markdown
可以是以下之一： markdown, gfm
gfm
context
在 gfm 模式下创建引用时要使用的代码库上下文。例如，将 context 设置为 octo-org/octo-repo 会将文本 #42 更改为指向 octo-org/octo-repo 代码库中问题 42 的 HTML 链接。
octo-org/octo-repo
#42
200
OK
304
未修改
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/markdown \ -d '{"text":"Hello **world**"}'
响应示例
状态：200
"<p>Hello <strong>world</strong></p>"
您必须将 Markdown 作为纯文本（使用 Content-Type 标头 text/plain 或 text/x-markdown）发送到此端点，而不是使用 JSON 格式。在原始模式下，GitHub Flavored Markdown 不受支持，并且 Markdown 将以与 README.md 文件类似的纯格式呈现。Markdown 内容必须小于或等于 400 KB。
Content-Type
text/plain
text/x-markdown
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/markdown/raw \ -d '{"text":"Hello **world**"}'