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.

Select a section heading to open its anchor and copy the URL. The # marks the permalink when you hover over the heading or focus it with Tab. It stays visible on touch screens. The URL keeps the page's language and documentation version.

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](../02-getting-started/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/.

Edit this page

Add editPage to your configuration to show an edit link above the previous and next buttons on live documentation pages.

ts
export default defineConfig({
  metadata: { applicationName: 'My documentation' },
  editPage: {
    baseUrl: 'https://github.com/your-org/your-repo/edit/main/apps/web',
  },
})

Point baseUrl to the editor URL for your branch, ending at the directory that contains rdx.config.ts. For a project at the repository root, end the example URL at /edit/main. RDX appends the path of the page's Markdown file, including docs/ or its translation directory. Published snapshots and pages showing a translation fallback omit the link. Set editPage: false to turn it off.