Markdown API
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, Self-managed, GitLab Dedicated
Convert Markdown content to HTML.
Available only in APIv4.
Required authentication
On self-managed GitLab, by default this feature is enabled and authentication is required.
To remove the requirement to authenticate, an administrator can
disable the feature flag named authenticate_markdown_api
.
On GitLab.com, this feature is available. On GitLab Dedicated, 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>" }
Docs
Edit this page to fix an error or add an improvement in a merge request.
Create an issue to suggest an improvement to this page.
Product
Create an issue if there's something you don't like about this feature.
Propose functionality by submitting a feature request.
Feature availability and product trials
View pricing to see all GitLab tiers and features, or to upgrade.
Try GitLab for free with access to all features for 30 days.
Get help
If you didn't find what you were looking for, search the docs.
If you want help with something specific and could use community support, post on the GitLab forum.
For problems setting up or using this feature (depending on your GitLab subscription).
Request support