@docusaurus/mdx-loader
Advanced tools
@docusaurus/mdx-loader is a webpack loader for MDX (Markdown with JSX) files, specifically designed to work with Docusaurus, a static site generator. It allows you to write content in Markdown and embed React components within that content.
Loading MDX files
This feature allows you to load and process MDX files using webpack. The loader converts MDX content into React components, enabling you to use Markdown and JSX together.
module.exports = {
module: {
rules: [
{
test: /\.mdx?$/,
use: [
{
loader: '@docusaurus/mdx-loader',
options: {
// Options for the loader
},
},
],
},
],
},
};Customizing MDX processing
This feature allows you to customize the MDX processing by adding remark and rehype plugins. In this example, the loader is configured to use 'remark-math' and 'rehype-katex' plugins for rendering mathematical expressions.
module.exports = {
module: {
rules: [
{
test: /\.mdx?$/,
use: [
{
loader: '@docusaurus/mdx-loader',
options: {
remarkPlugins: [require('remark-math')],
rehypePlugins: [require('rehype-katex')],
},
},
],
},
],
},
};mdx-loader is a webpack loader for MDX files, similar to @docusaurus/mdx-loader but not specifically tailored for Docusaurus. It allows you to use MDX in any webpack-based project.
gatsby-plugin-mdx is a plugin for Gatsby that enables the use of MDX in Gatsby projects. It provides similar functionality to @docusaurus/mdx-loader but is designed to work within the Gatsby ecosystem.
next-mdx-remote is a library for using MDX with Next.js. It allows you to load MDX content remotely and render it in Next.js pages, providing similar capabilities to @docusaurus/mdx-loader but for the Next.js framework.
@docusaurus/mdx-loaderDocusaurus webpack loader for MDX.
yarn add @docusaurus/mdx-loader
// ...
module: {
rules: [
// ...
{
test: /\.mdx?$/,
use: [
'babel-loader',
{
loader: '@docusaurus/mdx-loader',
options: {
// .. See options
},
},
],
},
];
}
rehypePluginsArray of rehype plugins to manipulate the MDXHAST
remarkPluginsArray of remark plugins to manipulate the MDXAST
metadataPathA function to provide the metadataPath depending on current loaded MDX path that will be exported as the MDX metadata.
2.0.0-beta.9 (2021-11-02)
docusaurus-theme-classic, docusaurus-theme-common
docusaurus-types, docusaurus
docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia
docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-types, docusaurus
docusaurus-theme-classic
create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader
docusaurus-plugin-content-blog
docusaurus
docusaurus-module-type-aliases, docusaurus
docusaurus-preset-classic
docusaurus
docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils, docusaurus
docusaurus-theme-classic
create-docusaurus
create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader
docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus
docusaurus-module-type-aliases, docusaurus-plugin-client-redirects, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils, docusaurus
docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, lqip-loader
FAQs
Docusaurus Loader for MDX
The npm package @docusaurus/mdx-loader receives a total of 292,483 weekly downloads. As such, @docusaurus/mdx-loader popularity was classified as popular.
We found that @docusaurus/mdx-loader demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.