Markdown – Design

​

Options

Markdown renders GitHub Flavored Markdown source into Carto-styled HTML — headings, inline formatting, lists, code, quotes, and tables.

​

Basic text

Bold (**text**) and italic (*text*) are standard CommonMark. Standard markdown has no distinct underline syntax, so strikethrough (~~text~~, GitHub Flavored Markdown) is the closest additional emphasis available.

​

Headings

Four heading levels map to Text’s headline sizes: h1 renders hero, h2 renders major, h3 renders substantial, and h4 renders regular. h5 and h6 also render but reuse the regular size, relying on the semantic tag alone to signal depth.

​

Inline Formatting

Bold, italic, inline code, and links combine freely within a single line of prose.

​

Lists

Unordered and ordered lists nest to any depth. GitHub Flavored Markdown task lists (- [x] / - [ ]) render as read-only checkboxes reflecting each item’s completion — they aren’t interactive.

​

Code

Inline code uses a tile background. Fenced code blocks (```) render in a bordered surface; Markdown doesn’t syntax-highlight by language.

​

Quotes

A blockquote (>) indents quoted prose with a leading rule. A horizontal rule (---) separates unrelated sections of content.

​

Tables

Tables (GitHub Flavored Markdown) render as a read-only chat table: a bordered header row, compact body cells, and a 265px height cap. Extra columns or rows scroll inside the table; the header stays in view and overflow fades appear when more content remains. Cells accept bold, italic, and links.

​

Behavior

Markdown is presentational — the only interactive element it can render is a link, and task-list checkboxes are read-only. Tall or wide tables scroll inside the table region rather than expanding the chat column.

​

Usage Guidelines

​

When to Use

Use the Markdown when:

• Rendering agent responses – The agent returns markdown source with headings, emphasis, lists, code, or quotes.
• Showing a table in the conversation – A response includes a table. Markdown renders it as a read-only table that scrolls within a fixed height.
• Formatting a dialog body – A Dialog message needs formatted text. Pass rendered Markdown as the Dialog content.

​

When not to use

Avoid using the Markdown for:

• Styling single-block copy – A headline, body copy, or label needs no lists, tables, code, or quotes. Use the Text instead.
• Collecting selections from a checklist – Markdown task lists are read-only. Use the Checkbox instead.

​

Keyboard Interaction

Users can navigate and activate any link rendered within the Markdown using standard keyboard controls. Overflowing tables expose a focusable scroll region so keyboard users can pan the table.