Getting Started with MDX
The fastest way to get started with Gatsby + MDX is to use the MDX
allows you to write .mdx files in
src/pages in order to create new pages on
Initialize the MDX starter with the Gatsby CLI
Run the dev server by changing directory to the scaffolded site and install dependencies
Open the site running at http://localhost:8000
Update the MDX content by opening the
my-mdx-starterdirectory in your code editor of choice and edit
src/pages/index.mdx. Save your changes and the browser will update in real time!
If you already have a Gatsby site that you’d like to add MDX to, you can follow these steps for configuring the gatsby-plugin-mdx plugin.
Alternatively, you may be looking to configure an existing blog site to use MDX. This blog post walks you through those steps in detail.
gatsby-plugin-mdxand MDX as dependencies
Note: If you’re upgrading from v0, additionally check out the MDX migration guide.
gatsby developand add an
.mdxpage to `src/pages
Note: If you want to query for frontmatter, exports, or other fields like
tableOfContentsand you haven’t previously added a
src/pagesin your project, you’ll want to add one now.
Go check out the writing MDX guide to find out what else you can do with Gatsby and MDX.
Edit this page on GitHub