Documentation sites and MDX

Detect the documentation project#

Open the repository root with the site’s configuration and dependencies. Markdown Pro detects MkDocs, Docusaurus, Fumadocs, VitePress, Hugo, and Jekyll, or you can select a profile explicitly under Settings → Tools → Markdown Pro → Documentation and MDX.

Set the documentation root to the content directory used by the site. Front-matter slugs, permalinks, aliases, navigation files, and relative paths affect route resolution. Test a link to another article and a site-root link before relying on whole-site inspections.

Preview real MDX#

1. Install the site’s dependencies using its normal package manager.
2. In WebStorm or IntelliJ IDEA Ultimate, open an .mdx article within the detected framework project.
3. Allow the configured development server to start, or enter the existing site-preview URL.
4. Check that the preview opens the article’s actual route and renders imported components.
5. Make an edit and confirm that the live route updates.

The renderer reconnects while a site starts. If a transparent theme is hard to read, set a canvas override in the documentation settings. In IDE editions without JavaScript framework support, the safe Markdown preview remains available, with JSX-style source highlighting but without live React rendering.

Check navigation before publishing#

Follow resolved links from an article, including links using front matter or aliases. Review unresolved-route and orphan-page warnings after configuring the profile. The plugin assists with authoring; run the site’s production build as the final check of routes and framework-specific behavior.