MDX routes and documentation inspections

Configure the site model#

Open the repository containing the documentation configuration, content, and dependencies. In Documentation and MDX settings, confirm the detected profile and documentation root. A path starting with / can be a site route, while ./next.md is file-relative; the correct framework context determines resolution.

For example, a front-matter slug can make the published URL differ from the filename:

---
title: Install the tool
slug: setup
---

See [configuration](/configuration/).

Use your framework’s actual front-matter rules. A generic slug field does not mean the same thing in every static-site generator.

Preview real MDX#

An MDX component needs the framework runtime, not just Markdown rendering:

import Card from '../components/Card'

# Installation

<Card title="Before you start">Install the project dependencies.</Card>

In a supported JavaScript-capable IDE, install dependencies and allow the detected development script to start, or configure its complete preview URL. Confirm the current file maps to the expected route and that Card renders. An IDE without the required framework support uses the safe Markdown-style fallback.

Inspect links and navigation#

Check links using relative files, site-root routes, front-matter slugs/permalinks, and aliases. Navigation and sidebar files help determine whether a page is reachable. An orphan warning may mean the page was never linked, but it may also mean the selected profile/root is wrong.

Before deleting an apparently orphaned page, inspect incoming links, aliases, and dynamic framework routing. Run the framework’s production build after fixing warnings; the IDE does not replace its complete route generation.

A framework-backed MDX preview renders imported components and tables. Select the image to view it at full size.