Markdown
Используйте REST API для отрисовки документа Markdown в виде HTML-страницы или как необработанного текста.
Render a Markdown document
Параметры
Заголовки |
---|
Имя, Тип, Описание |
accept stringSetting to |
Параметры запроса |
Имя, Тип, Описание |
text stringОбязательноThe Markdown text to render in HTML. |
mode stringThe rendering mode. Значение по умолчанию: Может быть одним из: |
context stringThe repository context to use when creating references in |
Коды состояния HTTP-ответа
Код состояния | Описание |
---|---|
200 | OK |
304 | Not modified |
Примеры кода
curl \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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.
Коды состояния HTTP-ответа
Код состояния | Описание |
---|---|
200 | OK |
304 | Not modified |
Примеры кода
curl \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/markdown/raw \
-d '{"text":"Hello **world**"}'
Example response
Status: 200
"<p>Hello <strong>world</strong></p>"