Skip to content
Writing documentation

Document links

Write file paths and let RDX resolve documentation URLs.

Read the Tabs example or the Accordion example. Jump directly to the Markdown example.

md
[Tabs](./tabs.mdx)
[Accordion](./accordion.mdx)

RDX resolves the file path inside the same documentation version. Use relative paths from the source document to keep links aligned with your content files. Include the target file extension: [Guide](./guide.md) can link from an MDX page to a Markdown page, and [Reference](./reference.mdx) works in reverse.

Return to relative links. Markdown headings receive automatic IDs for direct section links.

Paths, assets, and versions

Relative .md and .mdx links keep readers in the same edition. A snapshot cannot fall back to a newer page that did not exist when it was created. Query strings and fragments are preserved:

md
[A section](./tabs.mdx#write-your-own-tabs)
[A guide](../cat-02/config.mdx)

Use exact filename capitalization and forward slashes, including on Windows. Root-relative URLs, external links, downloads, images, and code samples are not rewritten. For images, use paths from public/.