Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub

Gatsby

Gatsby theme MDX

Gatsby theme that let you create pages from .mdx files inside the pages directory

Installation

  • Install the theme
npm i --save @horacioh/gatsby-theme-mdx
# or
yarn add @horacioh/gatsby-theme-mdx
  • Add the theme to yout gatsby-config.js files
# gatsby-config.js

module.exports = {
  // ...
  plugins: [
    // ...
    `@horacioh/gatsby-theme-mdx`,
  ]
}
  • Create .mdx files on your src/pages folder and you are all set.
// pages/index.mdx

# Hello MDX page

This theme includes

  • gatsby-plugin-mdx: to transform .mdx files to pages. docs
  • gatsby-plugin-prismjs: to style codeblocks properly. docs
  • gatsby-plugin-theme-ui: base & extensable styles for theme components. docs

Issues & feedback

Any questions or feedback is welcome!. please if you don’t understand something or need more documentation os some utility please file an issue or send me a tweet.

Happy Theming!!

© 2023 Gatsby, Inc.