perf(theme-mermaid): lazy load the Mermaid library #11438
Merged
Conversation
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
✅ [V2]
To edit notification comments on pull requests, go to your Netlify project configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
|
Size Change: +191 B (0%) Total Size: 11.8 MB
ℹ️ View Unchanged
|
|
Size Change: +205 B (0%) Total Size: 12.2 MB
ℹ️ View Unchanged
|
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.
Motivation
I noticed that the Mermaid lib is heavy and is loaded eagerly.
It is only called in
useEffect, so it's fine to defer the loading.Result
It doesn't impact all pages, but for some of them (in particular docs page not using diagrams), the amount of JS loaded can be quite significantly reduced, with one large chunk becoming much smaller.
The mermaid code has probably been split by the bundler into another chunk that will not load on docs page without diagrams, and will load later, after hydration on docs pages using diagrams.
Before
After
Test Plan
CI + preview
Test links
Deploy preview: https://deploy-preview-11438--docusaurus-2.netlify.app/