Skip to content
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@ Under `seo`, `trailingSlash: true` emits trailing-slash URLs in canonicals, the
```

- `instructions`: String or array, appended to every page served as Markdown to AI agents.
- `schema`: Include the full OpenAPI or AsyncAPI spec in API pages served as Markdown. Default: `true`. GraphQL reference pages always include their schema details (arguments, return types, fields) in Markdown; `schema` does not affect them.
- `schema`: Include the full OpenAPI or AsyncAPI spec in API pages served as Markdown. Default: `true`. GraphQL reference pages always include their schema details (arguments, return types, fields) in Markdown, and query and mutation pages also include an `Examples` section (operation, required variables, sample response); `schema` does not affect them.

## Search

Expand Down
2 changes: 1 addition & 1 deletion ai/markdown-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,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 170 in ai/markdown-export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/markdown-export.mdx#L170

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 All @@ -184,7 +184,7 @@
}
```

Markdown exports of [GraphQL](/api-playground/graphql-setup) reference pages include the schema details for the page. Operation pages list the operation's signature, arguments, return type, and the fields of the return type. Type pages list the type's kind, fields, enum values, implemented interfaces, or possible types. The `markdown.schema` setting does not apply to GraphQL pages.
Markdown exports of [GraphQL](/api-playground/graphql-setup) reference pages include the schema details for the page. Operation pages list the operation's signature, arguments, return type, and the fields of the return type. Query and mutation pages also include an `Examples` section with the same example operation, required variables, and sample JSON response that the page shows. Type pages list the type's kind, fields, enum values, implemented interfaces, or possible types. The `markdown.schema` setting does not apply to GraphQL pages.

## Custom agent instructions

Expand Down
Loading