Skip to main content
설명서에 자주 업데이트를 게시하며 이 페이지의 번역이 계속 진행 중일 수 있습니다. 최신 정보는 영어 설명서를 참조하세요.
이제 REST API의 버전이 지정되었습니다. 자세한 내용은 "API 버전 관리 정보"를 참조하세요.

Markdown

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

Render a Markdown document

에서 작동 GitHub Apps

매개 변수

헤더
Name, Type, 설명
acceptstring

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

본문 매개 변수
Name, Type, 설명
textstring필수

The Markdown text to render in HTML.

modestring

The rendering mode.

기본값: markdown

다음 중 하나일 수 있습니다.: markdown, gfm

contextstring

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.

HTTP 응답 상태 코드

상태 코드Description
200

OK

304

Not modified

코드 샘플

post/markdown
curl \ -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

에서 작동 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.

HTTP 응답 상태 코드

상태 코드Description
200

OK

304

Not modified

코드 샘플

post/markdown/raw
curl \ -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>"