feat(theme-mermaid): upgrade Mermaid to v10.4 - handle async rendering #9305
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
slorber
added
pr: new feature
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
|
Size Change: +239 B (0%) Total Size: 1.11 MB
ℹ️ View Unchanged
|
slorber
commented
Sep 14, 2023
Comment on lines
+72
to
+79
| try { | ||
| return await mermaid.render(id, text); | ||
| } catch (e) { | ||
| // Because Mermaid add a weird SVG/Message to the DOM on error | ||
| // https://github.com/mermaid-js/mermaid/issues/3205#issuecomment-1719620183 | ||
| document.querySelector(`#d${id}`)?.remove(); | ||
| throw e; | ||
| } |
There was a problem hiding this comment.
Note to future self, track if Mermaid fix their weird errorRender.
7 tasks
slorber
changed the title
4 tasks
This was referenced Jun 14, 2024
This was referenced Jun 16, 2024
This was referenced Jun 20, 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.
Breaking change
We upgrade Mermaid v9 to v10. Like all major version upgrades, Mermaid v10+ comes with its own breaking changes documented here:
The Docusaurus code has also evolved to adapt for those breaking changes, notably the fact
Mermaid.renderis async now.In theory most Docusaurus Mermaid users shouldn't be affected by those changes that are handled internally in our Mermaid theme. But we can't be 100% sure, so make sure to read the full v10 changelog.
Motivation
Fix #9032
Mermaid v10.4 comes with a few features that have been requested by Docusaurus users, notably:
Test Plan
Preview
Test links
https://deploy-preview-9305--docusaurus-2.netlify.app/tests/pages/diagrams