Skip to content

Commit

Permalink
Fix mdx docs (#40402)
Browse files Browse the repository at this point in the history
## 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 <jj@jjsweb.site>
  • Loading branch information
andrewrjohn and ijjk committed Sep 9, 2022
1 parent d64fc54 commit 38169e3
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/advanced-features/using-mdx.md
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions packages/next-mdx/readme.md
Expand Up @@ -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
Expand Down

0 comments on commit 38169e3

Please sign in to comment.