@astrojs/mdx
This Astro integration enables the usage of MDX components and allows you to create pages as .mdx
files.
Why MDX?
Section titled Why MDX?MDX allows you to use variables, JSX expressions and components within Markdown content in Astro. If you have existing content authored in MDX, this integration allows you to bring those files to your Astro project.
Installation
Section titled InstallationQuick Install
Section titled Quick InstallThe astro add
command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren’t sure which package manager you’re using, run the first command.) Then, follow the prompts, and type “y” in the terminal (meaning “yes”) for each one.
If you run into any issues, feel free to report them to us on GitHub and try the manual installation steps below.
Manual Install
Section titled Manual InstallFirst, install the @astrojs/mdx
package using your package manager. If you’re using npm or aren’t sure, run this in the terminal:
Then, apply this integration to your astro.config.*
file using the integrations
property:
Editor Integration
Section titled Editor IntegrationVS Code supports Markdown by default. However, for MDX editor support, you may wish to add the following setting in your VSCode config. This ensures authoring MDX files provides a Markdown-like editor experience.
Usage
Section titled UsageWith the Astro MDX integration, you can add MDX pages to your project by adding .mdx
files within your src/pages/
directory. You can also import .mdx
files into .astro
files.
Astro’s MDX integration adds extra features to standard MDX, including Markdown-style frontmatter. This allows you to use most of Astro’s built-in Markdown features like a special frontmatter layout
property and a property for marking a page as a draft.
See how MDX works in Astro with examples in our MD/MDX guide.
Visit the MDX docs to learn about using standard MDX features.
Configuration
Section titled ConfigurationOnce the MDX integration is installed, no configuration is necessary to use .mdx
files in your Astro project.
remarkPlugins
Section titled remarkPluginsBrowse awesome-remark for a full curated list of remark plugins to extend your Markdown’s capabilities.
This example applies the remark-toc
plugin to .mdx
files. To customize plugin inheritance from your Markdown config or Astro’s defaults, see the extendPlugins
option.
rehypePlugins
Section titled rehypePluginsBrowse awesome-rehype for a full curated list of Rehype plugins to transform the HTML that your Markdown generates.
We apply our own (non-removable) collect-headings
plugin. This applies IDs to all headings (i.e. h1 -> h6
) in your MDX files to link to headings via anchor tags.
This example applies the rehype-accessible-emojis
plugin to .mdx
files. To customize plugin inheritance from your Markdown config or Astro’s defaults, see the extendPlugins
option.
remarkRehype
Section titled remarkRehypeMarkdown content is transformed into HTML through remark-rehype which has a number of options.
You can use remark-rehype options in your config file like so:
This inherits the configuration of markdown.remarkRehype
. This behavior can be changed by configuring extendPlugins
.
extendPlugins
Section titled extendPluginsYou can customize how MDX files inherit your project’s existing Markdown configuration using the extendPlugins
option.
markdown
(default)
Section titled markdown (default)Astro’s MDX files will inherit all markdown
options in your Astro configuration file, which includes the GitHub-Flavored Markdown and Smartypants plugins by default.
Any additional plugins you apply in your MDX config will be applied after your configured Markdown plugins.
astroDefaults
Section titled astroDefaultsAstro’s MDX files will apply only Astro’s default plugins, without inheriting the rest of your Markdown config.
This example will apply the default GitHub-Flavored Markdown and Smartypants plugins alongside remark-toc
to your MDX files, while ignoring any markdown.remarkPlugins
configuration:
false
Section titled falseAstro’s MDX files will not inherit any markdown
options, nor will any Astro Markdown defaults be applied:
recmaPlugins
Section titled recmaPluginsThese are plugins that modify the output estree directly. This is useful for modifying or injecting JavaScript variables in your MDX files.
We suggest using AST Explorer to play with estree outputs, and trying estree-util-visit
for searching across JavaScript nodes.
Examples
Section titled Examples- The Astro MDX starter template shows how to use MDX files in your Astro project.
Troubleshooting
Section titled TroubleshootingFor help, check out the #support
channel on Discord. Our friendly Support Squad members are here to help!
You can also check our Astro Integration Documentation for more on integrations.
Contributing
Section titled ContributingThis package is maintained by Astro’s Core team. You’re welcome to submit an issue or PR!
Changelog
Section titled ChangelogSee CHANGELOG.md for a history of changes to this integration.