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. This feature is available for testing, but not ready for production use.
Render Markdown content
POST /api/v4/markdown
Renders Markdown content as HTML.
Request body (application/json)
| Property | Type | Description |
|---|---|---|
gfm | Boolean | Render text using Git Default: false |
project | String | Project used as context when creating references with Git |
textRequired | String | Markdown text to render |
Responses
| Code | Description | Schema |
|---|---|---|
201 | Created | APIEntities |
400 | Bad request | — |
401 | Unauthorized | — |
Schemas
Objects returned by the operations above and objects nested in their request bodies.
APIEntitiesMarkdown
| Property | Type | Description |
|---|---|---|
html | String | Example:<p dir=\"auto\">Hello world!</ |