ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。
記事のバージョン: GitHub.com

Markdown

ここには以下の内容があります:

post /markdown

パラメータ

Name Type In Description
accept string header

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

text string body

Required. The Markdown text to render in HTML. Markdown content must be 400 KB or less.

mode string body

The rendering mode. Can be either:
* markdown to render a document in plain Markdown, just like README.md files are rendered.
* gfm to render a document in GitHub Flavored Markdown, which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.

Default: markdown
context string body

The repository context to use when creating references in gfm mode. Omit this parameter when using markdown mode.

コードサンプル

Shell
curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/markdown \
  -d '{"text":"text"}'
JavaScript (@octokit/core.js)
await octokit.request('POST /markdown', {
  text: 'text'
})

Response

Status: 200 OK

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.

post /markdown/raw

パラメータ

Name Type In Description
accept string header

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

content-type string header

Setting content-type header is required for this endpoint

コードサンプル

Shell
curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/markdown/raw \
  -d '{"data":"data"}'
JavaScript (@octokit/core.js)
await octokit.request('POST /markdown/raw', {
  data: 'data',
  headers: {
    'content-type': 'text/plain; charset=utf-8'
  }
})

Response

Status: 200 OK

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください