Skip to main content
설명서에 자주 업데이트를 게시하며 이 페이지의 번역이 계속 진행 중일 수 있습니다. 최신 정보는 영어 설명서를 참조하세요.
사이트 관리자가 엔터프라이즈 서버 instance Enterprise Server 3.9 이상으로 업그레이드하면 REST API의 버전이 지정됩니다. instance 버전을 찾는 방법을 알아보려면 "GitHub Docs 버전 정보"를 참조하세요. 자세한 내용은 "API 버전 관리 정보"를 참조하세요.

Markdown

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

Render a Markdown document

에서 작동 GitHub Apps

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

헤더
속성, 형식, Description
accept string

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

본문 매개 변수
속성, 형식, Description
text string 필수

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 응답 상태 코드

상태 코드Description
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>" \ http(s)://HOSTNAME/api/v3/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.

"Render a Markdown document in raw mode"에 대한 HTTP 응답 상태 코드

상태 코드Description
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>" \ http(s)://HOSTNAME/api/v3/markdown/raw \ -d '{"text":"Hello **world**"}'

Example response

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