Конечные точки REST API для Markdown
Используйте REST API для отображения документа markdown в виде HTML-страницы или в виде необработанного текста.
Render a Markdown document
Подробные маркеры доступа для "Render a Markdown document
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Для тонкого маркера не требуются разрешения.
Эту конечную точку можно использовать без проверки подлинности, если запрашиваются только общедоступные ресурсы.
Параметры для "Render a Markdown document"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
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 |
Коды состояния http-ответа для "Render a Markdown document"
Код состояния | Описание |
---|---|
200 | OK |
304 | Not modified |
Примеры кода для "Render a Markdown document"
Пример запроса
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
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Для тонкого маркера не требуются разрешения.
Эту конечную точку можно использовать без проверки подлинности, если запрашиваются только общедоступные ресурсы.
Коды состояния http-ответа для "Render a Markdown document in raw mode"
Код состояния | Описание |
---|---|
200 | OK |
304 | Not modified |
Примеры кода для "Render a Markdown document in raw mode"
Примеры запросов
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>"