Markdown 用 REST API エンドポイント

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

Render a Markdown document

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

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンにはアクセス許可が必要ありません。

パブリックリソースのみが要求された場合、このエンドポイントは認証なしで使用できます。

"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" のコードサンプル

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

要求の例

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

"Hello world"

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" のきめ細かいアクセストークン

このエンドポイントは、次の粒度の細かいトークンの種類で動作します:

粒度の細かいトークンにはアクセス許可が必要ありません。

パブリックリソースのみが要求された場合、このエンドポイントは認証なしで使用できます。

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

状態コード	説明
`200`	OK
`304`	Not modified

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

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

要求の例

Select the example type

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

"Hello world"