Skip to main content
REST API теперь версия. Дополнительные сведения см. в разделе "О управлении версиями API".

Конечные точки REST API для Markdown

Используйте REST API для отображения документа markdown в виде HTML-страницы или в виде необработанного текста.

Render a Markdown document

Подробные маркеры доступа для "Render a Markdown document

This endpoint works with the following fine-grained token types:

Маркер не требует каких-либо разрешений.

Параметры для "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.

Коды состояния http-ответа для "Render a Markdown document"

Код состоянияОписание
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
"<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

This endpoint works with the following fine-grained token types:

Маркер не требует каких-либо разрешений.

Коды состояния http-ответа для "Render a Markdown document in raw mode"

Код состоянияОписание
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>" \ -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>"