-
-
Notifications
You must be signed in to change notification settings - Fork 8.6k
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.
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
fix(docs, blog): Markdown link resolution does not support hot reload #10185
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
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
Size Change: 0 B Total Size: 1.72 MB ℹ️ View Unchanged
|
This was referenced Jun 22, 2024
This was referenced Jun 22, 2024
This was referenced Jun 22, 2024
This was referenced Sep 8, 2024
This was referenced Sep 13, 2024
This was referenced Sep 28, 2024
This was referenced Sep 29, 2024
Closed
This was referenced Oct 4, 2024
This was referenced Oct 19, 2024
Open
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
Motivation
Fix #10152
The bug only happens during the dev experience because we "hot reload" the site.
When we create
1.md
and then reference it with a link such as[1][./1.md]
is another file, we get a markdown link resolution error.This happens because the "sourceToPermalink" map (that we use for resolving markdown links) is not updated when we reload/re-read the site's files, for both the docs and blog plugins.
Note: the solution I applied is not elegant, and relies on mutable map update side-effects. I don't know yet how to solve it properly considering the
configureWebpack
hook is only called once and it's not really safe to readloadedContent
from there, but I'll try to figure this out! Maybe this will require creating a new plugin lifecycle or using some moreadvanced Webpack features? 🤷♂️Note: I also refactored the data structure from
Record<string,string>
toMap<string,string>
for perf reasons.Test Plan
Unit tests keep passing + my local experience has
Test links
https://deploy-preview-10185--docusaurus-2.netlify.app/