Unverified Commit 4911a27e authored by Tim Neutkens's avatar Tim Neutkens Committed by GitHub

Add docs on how to use MDX with app (#44923)

Explains how to use the recent changes that allow for rendering MDX as
server components.
<!--
Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change that you're making:
-->

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see
[`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the
feature request has been accepted for implementation before opening a
PR.
- [ ] Related issues linked using `fixes #number`
- [ ]
[e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see
[`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm build && pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
Co-authored-by: 's avatarLee Robinson <me@leerob.io>
parent 98b43a07
...@@ -4,6 +4,8 @@ Use [MDX](https://github.com/mdx-js/mdx) with [Next.js](https://github.com/verce ...@@ -4,6 +4,8 @@ Use [MDX](https://github.com/mdx-js/mdx) with [Next.js](https://github.com/verce
## Installation ## Installation
For usage with the `app` directory see the section below.
``` ```
npm install @next/mdx @mdx-js/loader @mdx-js/react npm install @next/mdx @mdx-js/loader @mdx-js/react
``` ```
...@@ -76,3 +78,74 @@ module.exports = withMDX({ ...@@ -76,3 +78,74 @@ module.exports = withMDX({
## TypeScript ## TypeScript
Follow [this guide](https://mdxjs.com/advanced/typescript) from the MDX docs. Follow [this guide](https://mdxjs.com/advanced/typescript) from the MDX docs.
---
# App directory
## Installation
For usage with the `app` directory see below.
```
npm install @next/mdx
```
or
```
yarn add @next/mdx
```
## Usage
Create a `mdx-component.js` file at the root of your project with the following contents:
```js
// This file is required to use @next/mdx in the `app` directory.
export function useMDXComponents(components) {
return components
// Allows customizing built-in components, e.g. to add styling.
// return {
// h1: ({ children }) => <h1 style={{ fontSize: "100px" }}>{children}</h1>,
// ...components,
// }
}
```
Create a `next.config.js` in your project
```js
// next.config.js
const withMDX = require('@next/mdx')({
// Optionally provide remark and rehype plugins
options: {
// If you use remark-gfm, you'll need to use next.config.mjs
// as the package is ESM only
// https://github.com/remarkjs/remark-gfm#install
remarkPlugins: [],
rehypePlugins: [],
// If you use `MDXProvider`, uncomment the following line.
// providerImportSource: "@mdx-js/react",
},
})
/** @type {import('next').NextConfig} */
const nextConfig = {
// Configure pageExtensions to include md and mdx
pageExtensions: ['ts', 'tsx', 'js', 'jsx', 'md', 'mdx'],
experimental: {
appDir: true,
mdxRs: true
}
// Optionally, add any other Next.js config below
reactStrictMode: true,
}
// Merge MDX config with Next.js config
module.exports = withMDX(nextConfig)
```
## TypeScript
Follow [this guide](https://mdxjs.com/advanced/typescript) from the MDX docs.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment