Markdown
Markdown API 可让您渲染 markdown 文档作为 HTML 页面或原始文本。
Render a Markdown document
参数
标头 |
---|
名称, 类型, 描述 |
accept stringSetting to |
正文参数 |
名称, 类型, 描述 |
text string必选The Markdown text to render in HTML. |
mode stringThe rendering mode. Can be either 默认值: 可以是以下其中之一: |
context stringThe repository context to use when creating references in |
HTTP 响应状态代码
状态代码 | 描述 |
---|---|
200 | OK |
304 | Not modified |
代码示例
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
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 |