Configure MDX editor support #362
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
By default a TypeScript program includes all TypeScript files. However, because there’s an `include` pattern, `**/*.mdx`, has to be added for editor support. The `mdx.checkMdx` option turns subtle error hints in the editor into red squiggly lines. The global type `MDXProvidedComponents` configures the type of components injected into MDX. This provides support for `<Note />`, `<Image />`, etc. The `useMDXComponents()` function does not take any arguments. The documentation on which this was based, is wrong. (vercel/next.js#67188) For details, see https://github.com/mdx-js/mdx-analyzer
|
Thanks! How do we test the change? |
|
You’ll notice the difference in your editor. You need to use either the MDX language server or the MDX TypeScript plugin. Exact configurations can differ per editor. The MDX VSCode extension supports it by default. I will assume VSCode for the purpose of explaining. Because MDX files are now included in the same TypeScript program that’s defined by Hover before:
Hover after:
Because of the global
|
gaearon
approved these changes
Nov 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
By default a TypeScript program includes all TypeScript files. However, because there’s an
includepattern,**/*.mdx, has to be added for editor support.The
mdx.checkMdxoption turns subtle error hints in the editor into red squiggly lines.The global type
MDXProvidedComponentsconfigures the type of components injected into MDX. This provides support for<Note />,<Image />, etc.The
useMDXComponents()function does not take any arguments. The documentation on which this was based, is wrong.(vercel/next.js#67188)
For details, see https://github.com/mdx-js/mdx-analyzer