Each MDX file in the target directory will become its own route, with index.mdx serving as the base route, i.e. /.

With the following directory structure:


mdx-go will create routes for /, /getting-started, and /api.

React Components

mdx-go also supports using React components as routes for files with the .js extension. Be sure that the .js file exports a default component to render as a route.

// example React component route
import React from 'react'

export default props =>

Customizing Routes

Each page can customize its name, path, and other metadata using exports.

To set a custom name for the route, export a name string.

export const name = 'Getting Started'

# Getting Started

To set a custom path, without renaming the file, export a path string.

export const path = '/go'

# Getting Started