Fix intermittent Mermaid rendering failures#40
Merged
Conversation
Remove custom Mermaid swizzle that had race conditions (startOnLoad +
contentLoaded in empty-dep useEffect). The official @docusaurus/theme-mermaid
component handles rendering correctly via mermaid.render() with proper
React lifecycle management.
- Delete src/theme/Mermaid.tsx and src/components/mermaid.tsx
- Convert <Mermaid chart={}/> JSX to ```mermaid code fences
- Remove Mermaid lazy wrapper from MDXComponents
- Update CSS selectors from .mermaid to .docusaurus-mermaid-container
- Move font config to mermaid themeVariables so node sizes are calculated
correctly during rendering
e21919d to
ec23dfa
Compare
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
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.
Summary
src/theme/Mermaid.tsxswizzle that caused ~20% blank/broken diagrams due to race conditions (startOnLoad: true+contentLoaded()in empty-depuseEffect)@docusaurus/theme-mermaidcomponent which usesmermaid.render()with proper React lifecycle<Mermaid chart={...}/>JSX to idiomatic```mermaidcode fences.mermaidto.docusaurus-mermaid-container(the official component's wrapper class)themeVariablesso node sizes are calculated correctly during rendering (prevents text truncation)Test plan
npm run buildpasses