Skip to content

Update from code changes: Markdown forms for Frame, Tile and more #7969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ethanpalm merged 1 commit into from
Oct 22, 2026
Merged

Update from code changes: Markdown forms for Frame, Tile and more #7969

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions ai/markdown-export.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,11 @@
| `Steps` and `Step` | Removes the `Steps` wrapper. Each step is a numbered title, such as `**1. Install the CLI**`. Set `stepNumber` to choose the number. Set `titleSize` to `h2`, `h3`, or `h4` to make the title a heading of that level. |
| `ParamField`, `ResponseField` | The name in bold, the type in code, and `required`, `deprecated`, or `default` when you set them. |
| `Tooltip` | The text, with the tip in parentheses. |
| `Frame` | The content, followed by the `caption` on its own line. |
| `Update` | The `label` in bold, then the `description` and the content. |
| `Tile` | The `title` in bold, or a link when `href` is set, then the `description` and the content. Without a `title`, the `aria-label` takes its place. |
| `Prompt` | The `description`, then the prompt text. |
| `Color.Item` | The `name` in bold and the `value` in code. A value with light and dark colors shows both, marked `(light)` and `(dark)`. |

A component without its own Markdown form keeps its text. Its `title` becomes bold, or a link when it also has an `href`, and its description or children follow.

Expand Down Expand Up @@ -108,7 +113,7 @@
Markdown exports never include component source code. When a page imports [custom React components](/customize/react-components) or data from snippet files, the Markdown export contains what those components display, not the code that defines them.

- **Components with static output** render as Markdown. For example, a component that returns a link, a list, or a table appears as that link, list, or table.
- **Interactive components** build their output from state or browser APIs, such as calculators, filterable galleries, and charts. They keep only their children and their `title`, `description`, `alt`, and `href` props. A component with none of these is omitted.

Check warning on line 116 in ai/markdown-export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/markdown-export.mdx#L116 

In general, use active voice instead of passive voice ('is omitted').
- **Imported data**, such as an object passed to a component as a prop, does not appear in Markdown exports.

Give agents a static version of an interactive component's content with the [visibility](/components/visibility) component. See [Interactive components](/components/visibility#interactive-components) for an example.
Expand Down
Loading