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

Update MDX document #33916

Merged
merged 2 commits into from Feb 2, 2022
Merged

Update MDX document #33916

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
183674c
Update MDX document
yuta-ike Feb 2, 2022
17d629b
Update docs/advanced-features/using-mdx.md
leerob Feb 2, 2022
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
4 changes: 3 additions & 1 deletion docs/advanced-features/using-mdx.md
View file
Open in desktop
Expand Up @@ -46,6 +46,8 @@ The following steps outline how to setup `@next/mdx` in your Next.js project:
options: {
remarkPlugins: [],
rehypePlugins: [],
// If you use `MDXProvider`, comment in the following line.
leerob marked this conversation as resolved.
Show resolved Hide resolved
// providerImportSource: "@mdx-js/react",
},
})
module.exports = withMDX({
Expand Down Expand Up @@ -153,7 +155,7 @@ The above generates the following `HTML`:
</ul>
```

When you want to style your own elements to give a custom feel to your website or application, you can pass in shortcodes. These are your own custom components that map to `HTML` elements. To do this you use the `MDXProvider` and pass a components object as a prop. Each object key in the components object maps to a `HTML` element name.
When you want to style your own elements to give a custom feel to your website or application, you can pass in shortcodes. These are your own custom components that map to `HTML` elements. To do this you use the `MDXProvider` and pass a components object as a prop. Each object key in the components object maps to a `HTML` element name. You also need to specify `providerImportSource: "@mdx-js/react"` in `next.config.js`.

```jsx
// pages/index.js
Expand Down