REST-API-Endpunkte für Markdown

Verwende die REST-API, um ein Markdowndokument als HTML-Seite oder unformatierten Text zu rendern.

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.

Differenzierte Zugriffstoken für "Render a Markdown document"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Contents" repository permissions (read)

Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für „Render a Markdown document“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Textparameter
Name, type, BESCHREIBUNG
`text` string Erforderlich The Markdown text to render in HTML.
`mode` string The rendering mode. Standard: `markdown` Kann eine der Folgenden sein: `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-Antwortstatuscodes für „Render a Markdown document“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified

Codebeispiele für „Render a Markdown document“

Anforderungsbeispiel

post/markdown

curl -L \
  -X POST \
  -H "Accept: text/html" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/markdown \
  -d '{"text":"Hello **world**"}'

Example response

Status: 200

"Hello world"

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.

Differenzierte Zugriffstoken für "Render a Markdown document in raw mode"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token erfordert keine Berechtigungen.

Dieser Endpunkt kann ohne Authentifizierung werden, wenn nur öffentliche Ressourcen angefordert werden.

HTTP-Antwortstatuscodes für „Render a Markdown document in raw mode“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified

Codebeispiele für „Render a Markdown document in raw mode“

Beispiele für Anforderungen

Select the example type

post/markdown/raw

curl -L \
  -X POST \
  -H "Accept: text/html" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/markdown/raw \
  -d '{"text":"Hello **world**"}'

Example response

Status: 200

"Hello world"