From 38169e338559207f851fc6022c9d7638417d94a0 Mon Sep 17 00:00:00 2001 From: Andrew Johnson Date: Fri, 9 Sep 2022 14:12:36 -0500 Subject: [PATCH] Fix mdx docs (#40402) ## Documentation / Examples - [x] Make sure the linting passes by running `pnpm lint` - [x] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples) The MDX guide is missing `@mdx-js/react` as a required dependency in the setup section. Co-authored-by: JJ Kasper --- docs/advanced-features/using-mdx.md | 2 +- packages/next-mdx/readme.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/advanced-features/using-mdx.md b/docs/advanced-features/using-mdx.md index 6ed9b3f5756f..859db74188aa 100644 --- a/docs/advanced-features/using-mdx.md +++ b/docs/advanced-features/using-mdx.md @@ -33,7 +33,7 @@ The following steps outline how to setup `@next/mdx` in your Next.js project: 1. Install the required packages: ```bash - npm install @next/mdx @mdx-js/loader + npm install @next/mdx @mdx-js/loader @mdx-js/react ``` 2. Require the package and configure to support top level `.mdx` pages. The following adds the `options` object key allowing you to pass in any plugins: diff --git a/packages/next-mdx/readme.md b/packages/next-mdx/readme.md index e45ac2c203d7..111d8b33dbc7 100644 --- a/packages/next-mdx/readme.md +++ b/packages/next-mdx/readme.md @@ -5,13 +5,13 @@ Use [MDX](https://github.com/mdx-js/mdx) with [Next.js](https://github.com/verce ## Installation ``` -npm install @next/mdx @mdx-js/loader +npm install @next/mdx @mdx-js/loader @mdx-js/react ``` or ``` -yarn add @next/mdx @mdx-js/loader +yarn add @next/mdx @mdx-js/loader @mdx-js/react ``` ## Usage