Markdown API

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

Convert Markdown content to HTML.

Available only in APIv4.

Required authentication

History

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.

All API calls to the Markdown API must be authenticated.

Render an arbitrary Markdown document

POST /markdown
AttributeTypeRequiredDescription
textstringyesThe Markdown text to render
gfmbooleannoRender text using GitLab Flavored Markdown. Default is false
projectstringnoUse 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>" }