Skip to content
Last update: June 19, 2025

Markdown Control Descriptor

This control provides a Markdown editor. The content can be saved as Markdown, HTML, or both formats simultaneously.

Property Type Description
resultType markdown
html
mixed		 Determines the output format.
styles string[]
string		 Links to CSS files for styling the preview pane.
Be careful with CORS restrictions.
uploadAssetsRequest AssetsRequest Descriptor used to upload images pasted from the clipboard.
urlField string Field name used for the image URL.
filenameField string Field name used for the alt text of pasted images.

When the resultType is markdown or html, the control returns a string. For mixed, the value is an object containing both markdown and html properties.

If resultType is set to html, the editor converts the HTML back to Markdown using the turndown library.

Example

...
    "settings": [
        {
            "id": "content",
            "label": "Content",
            "type": "markdown",
            "resultType": "mixed"
        },
        ...
    ]

{
    "content": [
        {
            "type": "markdown-example",
            "content": {
                "markdown": "## Markdown example",
                "html": "<h2>Markdown example</h2>"
            }
        }
    ] 
}