Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Note missing plugins support in mdxRs, refine #72241

Merged
merged 2 commits into from
Nov 5, 2024
Merged

Note missing plugins support in mdxRs, refine #72241

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba51787
Note missing plugins support in mdxRs, refine
karlhorky Nov 3, 2024
cb4b75e
Merge branch 'canary' into patch-2
ijjk Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/02-app/01-building-your-application/07-configuring/05-mdx.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -616,21 +616,21 @@ A common use case for this is when you want to iterate over a collection of MDX
> - Using `fs`, `globby`, etc. can only be used server-side.
> - View the [Portfolio Starter Kit](https://vercel.com/templates/next.js/portfolio-starter-kit) template for a complete working example.

## Remark and Rehype Plugins
## remark and rehype Plugins

You can optionally provide `remark` and `rehype` plugins to transform the MDX content.
You can optionally provide remark and rehype plugins to transform the MDX content.

For example, you can use `remark-gfm` to support GitHub Flavored Markdown.
For example, you can use [`remark-gfm`](https://github.com/remarkjs/remark-gfm) to support GitHub Flavored Markdown.

Since the `remark` and `rehype` ecosystem is ESM only, you'll need to use `next.config.mjs` as the configuration file.
Since the remark and rehype ecosystem is ESM only, you'll need to use `next.config.mjs` or `next.config.ts` as the configuration file.

```js filename="next.config.mjs"
import remarkGfm from 'remark-gfm'
import createMDX from '@next/mdx'

/** @type {import('next').NextConfig} */
const nextConfig = {
// Configure `pageExtensions`` to include MDX files
// Allow .mdx extensions for files
pageExtensions: ['js', 'jsx', 'md', 'mdx', 'ts', 'tsx'],
// Optionally, add any other Next.js config below
}
Expand All @@ -643,10 +643,14 @@ const withMDX = createMDX({
},
})

// Wrap MDX and Next.js config with each other
// Combine MDX and Next.js config
export default withMDX(nextConfig)
```

> **Good to know**:
>
> remark and rehype plugins cannot be used with [Turbopack](/docs/architecture/turbopack), due to lack of plugins support in [`mdxRs`](#using-the-rust-based-mdx-compiler-experimental)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This message is wrong and the good to know here is also outdated.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh sorry, wasn't aware of that detail! PR open:


## Remote MDX

If your MDX files or content lives _somewhere else_, you can fetch it dynamically on the server. This is useful for content stored in a separate local folder, CMS, database, or anywhere else. A popular community package for this use is [`next-mdx-remote`](https://github.com/hashicorp/next-mdx-remote#react-server-components-rsc--nextjs-app-directory-support).
Expand Down
Loading