1.9 KiB
1.9 KiB
| stage | group | info |
|---|---|---|
| Plan | Project Management | To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments |
Markdown API (FREE)
Convert Markdown content to HTML.
Available only in APIv4.
Required authentication
Introduced in GitLab 15.3 with a flag named
authenticate_markdown_api. Enabled by default.
FLAG:
On self-managed GitLab, by default this feature is enabled and authentication is required.
To remove the requirement to authenticate, ask an administrator to
disable the feature flag named authenticate_markdown_api.
On GitLab.com, this feature is available.
All API calls to the Markdown API must be authenticated.
Render an arbitrary Markdown document
POST /markdown
| Attribute | Type | Required | Description |
|---|---|---|---|
text |
string | yes | The Markdown text to render |
gfm |
boolean | no | Render text using GitLab Flavored Markdown. Default is false |
project |
string | no | Use project as a context when creating references using GitLab Flavored Markdown |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-Type:application/json" \
--data '{"text":"Hello world! :tada:", "gfm":true, "project":"group_example/project_example"}' "https://gitlab.example.com/api/v4/markdown"
Response example:
{ "html": "<p dir=\"auto\">Hello world! <gl-emoji title=\"party popper\" data-name=\"tada\" data-unicode-version=\"6.0\">🎉</gl-emoji></p>" }