Markdown

tile/markdown

Shows Markdown-formatted text content, including headings, lists, links, images, code blocks, tables, and standard inline formatting.

Properties

Name	Required	Lightning Type	Default	Description
source	Yes	`lightning__markdownTextType`		A raw Markdown text string. Use Markdown syntax for headings, links, lists, code blocks, tables, and standard formatting.

Usage

Render a block of markdown-formatted text — headings, emphasis, links, images, lists, code blocks, blockquotes, and GFM tables — from a single source string. Use markdown when you have rich, formatted text to display.

For preformatted source code or a fenced code block, use tile/code instead. For plain, unformatted text, use tile/text instead.

Note

Embed newlines as \n in the source string. Extra whitespace is removed from the formatted text.

1{
2    "definition": "tile/markdown",
3    "attributes": {
4        "source": "# Heading\n\nSome **bold** and _italic_ text with a [link](https://example.com).\n\n- First item\n- Second item"
5    }
6}

To create a table, use standard CommonMark syntax or GitHub-flavored markdown.

1{
2    "definition": "tile/markdown",
3    "attributes": {
4        "source": "| Tile | Status |\n| --- | --- |\n| Text | Beta |\n| Markdown | Beta |"
5    }
6}

Consider these guidelines when working with markdown.

Task lists (- [ ]) aren’t supported.
Don’t use inline HTML because some tags are removed from the output.

Limitations

Note any limitations that apply to this component.

Slackbot

No known limitations for tile/markdown in Slackbot.

ChatGPT

No known limitations for tile/markdown in ChatGPT.

Agentforce

No known limitations for tile/markdown in Agentforce.