PageLink

Link to another page in this documentation. Preferred over a plain Markdown link — the title and description stay in sync with the target page's metadata.

Usage

Link to PageLink to a page in the guide

Props

PropTypeDescription
filepathstringPath to another MDX/Markdown page, relative to the content root (e.g. components/tabs).
uidstringAlternative to filepath for editor-managed docs.
titlestringOverride the target page's title.
descriptionstringOverride the target page's description.

Variants

Link to PageLink to a page in the guide Custom titleCustom description overrides the target page's metadata