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

[docs] Clarify that merely changing extension does not load .md f… #49785

Merged
merged 6 commits into from Jun 14, 2023
Merged

[docs] Clarify that merely changing extension does not load .md f… #49785

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c6ed99b
[docs] Clarify that merely changing `extension` does not load `.md` f…
joostdecock May 14, 2023
d1c3f6f
Update packages/next-mdx/readme.md
joostdecock May 15, 2023
f0f2c98
Update packages/next-mdx/readme.md
joostdecock May 15, 2023
8dec45f
Merge branch 'canary' into patch-1
styfle Jun 2, 2023
060a603
Merge branch 'canary' into patch-1
ijjk Jun 14, 2023
1b4aa86
lint fix
ijjk Jun 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion packages/next-mdx/readme.md
View file
Open in desktop
Expand Up @@ -51,7 +51,8 @@ module.exports = withMDX({
})
```

Optionally you can match other file extensions for MDX compilation, by default only `.mdx` is supported
By default MDX will only match and compile MDX files with the `.mdx` extension.
However, it can also be optionally configured to handle markdown files with the `.md` extension, as shown below:

```js
// next.config.js
Expand All @@ -61,6 +62,8 @@ const withMDX = require('@next/mdx')({
module.exports = withMDX()
```

In addition, MDX can be customized with compiler options, see the [mdx documentation](https://mdxjs.com/packages/mdx/#compilefile-options) for details on supported options.

## Top level .mdx pages

Define the `pageExtensions` option to have Next.js handle `.md` and `.mdx` files in the `pages` directory as pages:
Expand Down