Markdown API | GitLab Docs
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
Use this API to render Markdown content as HTML.
All requests to this API must be authenticated.
The availability of this feature is controlled by a feature flag. For more information, see the history. This feature is available for testing, but not ready for production use.
Render an arbitrary Markdown document
| 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>" }