docs: add legacy-peer-deps note for MDX installation - #39515
Open
nikhilkalburgi45 wants to merge 1 commit into
Open
docs: add legacy-peer-deps note for MDX installation#39515nikhilkalburgi45 wants to merge 1 commit into
nikhilkalburgi45 wants to merge 1 commit into
Conversation
gatsbot
Bot
added
the
status: triage needed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
I added a troubleshooting note to the MDX routing documentation. Many users using newer versions of npm (v7+) encounter "ERESOLVE unable to resolve dependency tree" errors during the installation of MDX dependencies. This PR provides the specific command using the
--legacy-peer-depsflag to help users get past this common installation blocker.Documentation
docs/docs/how-to/routing/mdx.mdto include the troubleshooting note and the alternative installation command.Tests
N/A - This is a documentation-only change. I verified the markdown formatting in my local editor.
Related Issues
Fixes #38928