Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub

Gatsby MDX theme

This Theme adds the MDX plugin & loads MDX files with file sytem plugin.

Installation & Usage

yarn add @awolf81/gatsby-theme-mdx

or

npm install @awolf81/gatsby-theme-mdx

Use the Theme by adding it to your gatsby-config.js file like this:

module.exports = {
  plugins: [
    {
      resolve: '@awolf81/gatsby-theme-mdx',
      options: {
        /* basePath: '/myCoolStuff' */
        /* contentPath: 'your-content-location' */
      },
    },
  ],
}

Run gatsby develop and add your first MDX file to the created docs folder. contentPath defaults to docs.

Options

basePath
The url where your MDX files are served
contentPath
The directory that will be created by the Theme. That's the location of your MDX files on disk.
© 2023 Gatsby, Inc.