Skip to main content
Die REST-API verfügt jetzt über eine Versionskontrolle. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

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

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“

StatuscodeBESCHREIBUNG
200

OK

304

Not modified

Codebeispiele für „Render a Markdown document“

Beispiel für eine Anfrage

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" \ http(s)://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-Antwortstatuscodes für „Render a Markdown document in raw mode“

StatuscodeBESCHREIBUNG
200

OK

304

Not modified

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

Beispiele für Anforderungen

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" \ http(s)://HOSTNAME/api/v3/markdown/raw \ -d '{"text":"Hello **world**"}'

Example response

Status: 200
"<p>Hello <strong>world</strong></p>"