마크다운

REST API를 사용하여 Markdown 문서를 HTML 페이지 또는 원시 텍스트로 렌더링합니다.

Render a Markdown document

"Render a Markdown document"에 대한 매개 변수

머리글
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

본문 매개 변수
이름, Type, 설명
`text` string Required The Markdown text to render in HTML.
`mode` string The rendering mode. 기본값: `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

"Hello world"

Render a Markdown document in raw mode

Works with GitHub Apps

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"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`304`	Not modified

"Render a Markdown document in raw mode"에 대한 코드 샘플

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"