Reference for the Include MDX component and supported props.
Include lets you reuse content from another documentation page.
Supported props
| Prop | Type | Required | Default | Purpose |
|---|---|---|---|---|
page | string | yes | none | Slug path of the page to include |
How it works
- In view mode,
Includeis resolved on the server before MDX render, so included content appears inline. - In edit/preview mode, it shows a placeholder block (
Include: <page>), so you can see reference target.
Common pitfalls
- Using unsupported prop names (
path,href) instead ofpage - Passing a wrong or moved page path
- Expecting placeholder behavior in final view mode
Last updated on