Markdown API
Introduced in GitLab 11.0.
Available only in APIv4.
Render an arbitrary Markdown document
POST /api/v4/markdown
| Attribute | Type | Required | Description |
|---|---|---|---|
text |
string | yes | The markdown text to render |
gfm |
boolean | no (optional) | Render text using GitLab Flavored Markdown. Default is false
|
project |
string | no (optional) | Use project as a context when creating references using GitLab Flavored Markdown. Authentication is required if a project is not public. |
curl --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>" }
Help and feedback
If there's something you don't like about this feature
To propose functionality that GitLab does not yet offer
To further help GitLab in shaping new features
If you didn't find what you were looking for
If you want help with something very specific to your use case, and can use some community support
POST ON GITLAB FORUM
If you have problems setting up or using this feature (depending on your GitLab subscription)
REQUEST SUPPORT
To view all GitLab tiers and features or to upgrade
If you want to try all features available in GitLab.com
If you want to try all features available in GitLab self-managed
If you spot an error or a need for improvement and would like to fix it yourself in a merge request
EDIT THIS PAGE
If you would like to suggest an improvement to this doc