Update MDX Custom Elements setup #34175
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The current documentation was not clear, ended up on vercel#30812 before I had this configured correctly, have tried to make the config steps more explicit.
dburrows
requested review from
timneutkens,
ijjk,
shuding,
styfle,
huozhi,
padmaia and
leerob
as code owners
docs/advanced-features/using-mdx.md
Outdated
| @@ -155,7 +155,23 @@ 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. You also need to specify `providerImportSource: "@mdx-js/react"` in `next.config.js`. | |||
| 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. | |||
There was a problem hiding this comment.
this could mention that in mdx v2 there's no need for a provider, i.e. it is possible to pass a components prop directly, see https://mdxjs.com/docs/using-mdx/#components
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current documentation for MDX Custom Element setup was not clear, ended up on #30812 before I had this configured correctly, have tried to make the config steps more explicit.
Documentation / Examples
yarn lint