Skip to content
Merged
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions ai/markdown-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

<PreviewButton href="https://mintlify.com/docs/ai/markdown-export.md">Open this page as Markdown</PreviewButton>

Links to other pages in your navigation point to their Markdown versions, so agents that follow a link keep reading Markdown. For example, `[Quickstart](/quickstart#install)` becomes `[Quickstart](/quickstart.md#install)` in the Markdown output. Links to pages that are not in your navigation, images, external URLs, and links inside code blocks stay as written.

## Accept header

Send a request with `Accept: text/markdown` or `Accept: text/plain` to any page URL to receive the Markdown version instead of HTML. This is useful for AI tools and integrations that programmatically fetch documentation content.
Expand Down Expand Up @@ -108,7 +110,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 113 in ai/markdown-export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/markdown-export.mdx#L113

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