The Markdown component displays markdown-formatted strings as styled rich text. Use it to render dynamic content from AI Summarizer components, external API responses, or any other source that returns markdown strings.
How to read settings tables
The tables below describe each configurable option as it displays in the Unqork IDE. Values are formatted as follows:
inline code— a value to type exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked
Content
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Property ID | key |
Text input | md |
The unique identifier for this component instance. |
| Canvas Label Text | title |
Text input | — | A display name for the component on the canvas. |
| Content | content |
Code editor | — | Static markdown content to display. Used as a placeholder or fallback when no dynamic value is provided. |
Display Settings
Default State Options
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Hide Field | hidden |
Toggle | OFF | Hides the component from end-users but always displays in the Module Builder. |
Supported Syntax
The Markdown component supports the following standard markdown syntax:
- Headers: H1 through H6.
- Bold and italic text:
**bold**and*italic*. - Ordered and unordered lists: Numbered lists and bulleted lists.
- Links: Inline hyperlinks.
- Inline code: Code formatted with backticks.
The Markdown component does not support extended markdown features like tables, footnotes, or task lists, and does not execute embedded scripts or HTML.
Connecting to Other Components
The Markdown component displays the value written to it by other components in the module. To populate it dynamically, set the source component's output to the Markdown component's Property ID.
For example, set the AI Summarizer component's Output setting to the Markdown component's Property ID to render generated summaries as styled text. The Markdown component can also receive values from a Hidden component storing a formatted response, or from a Plug-In component that returns markdown from an external API.
Limitations
- Standard markdown only: Extended features like tables, footnotes, and task lists are not supported.
- No script or HTML execution: Embedded scripts and HTML are blocked for security.
- Complex nesting: Deeply nested markdown structures might not render as expected.
- No built-in content sanitization warnings: Review the content source carefully when rendering user-generated content.
Changelog
| Date | Change |
|---|---|
| — | Initial publication. |