Markdown에 대한 REST API 엔드포인트
REST API를 사용하여 Markdown 문서를 HTML 페이지 또는 원시 텍스트로 렌더링합니다.
Render a Markdown document
Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as issues:read or pull_requests:read.
"Render a Markdown document"에 대한 세분화된 액세스 토큰
이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:
세분화된 토큰은 필수 권한 집합을 포함해야 합니다.:
- "Contents" repository permissions (read)
공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.
"Render a Markdown document"에 대한 매개 변수
| 이름, 유형, 설명 |
|---|
accept string Setting to |
| 이름, 유형, 설명 |
|---|
text string 필수The Markdown text to render in HTML. |
mode string The rendering mode. 기본값: 다음 중 하나일 수 있습니다.: |
context string The repository context to use when creating references in |
"Render a Markdown document"에 대한 HTTP 응답 상태 코드
| 상태 코드 | 설명 |
|---|---|
200 | OK |
304 | Not modified |
"Render a Markdown document"에 대한 코드 샘플
요청 예제
curl -L \
-X POST \
-H "Accept: text/html" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
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
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"에 대한 코드 샘플
요청 예제
curl -L \
-X POST \
-H "Accept: text/html" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
http(s)://HOSTNAME/api/v3/markdown/raw \
-d '{"text":"Hello **world**"}'Example response
Status: 200"<p>Hello <strong>world</strong></p>"