Skip to main content
REST API はバージョン管理になりました。 詳細については、「API のバージョン管理について」を参照してください。

Markdown 用 REST API エンドポイント

REST API を使って、Markdown ドキュメントを HTML ページまたは生のテキストとしてレンダリングします。

Render a Markdown document

"Render a Markdown document" のきめ細かいアクセス トークン

This endpoint works with the following fine-grained token types:

トークンにはアクセス許可は必要ありません。

"Render a Markdown document" のパラメーター

ヘッダー
名前, Type, 説明
accept string

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

本文のパラメーター
名前, Type, 説明
text string 必須

The Markdown text to render in HTML.

mode string

The rendering mode.

Default: 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.

"Render a Markdown document" の HTTP 応答状態コード

状態コード説明
200

OK

304

Not modified

"Render a Markdown document" のコード サンプル

要求の例

post/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 \ -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.

"Render a Markdown document in raw mode" のきめ細かいアクセス トークン

This endpoint works with the following fine-grained token types:

トークンにはアクセス許可は必要ありません。

"Render a Markdown document in raw mode" の HTTP 応答状態コード

状態コード説明
200

OK

304

Not modified

"Render a Markdown document in raw mode" のコード サンプル

要求の例

post/markdown/raw
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**"}'

Example response

Status: 200
"<p>Hello <strong>world</strong></p>"