Markdown - Документация по GitHub

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

Render a Markdown document

Работа с GitHub Apps

Параметры для "Render a Markdown document"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры запроса
Имя, Тип, Описание
`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

"Hello world"

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-ответа для "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

"Hello world"