Replace beautiful-mermaid with mermaid - #40
Draft
Fripe070 wants to merge 2 commits into
Draft
Conversation
Fripe070
added
code
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.
beautiful-mermaid has a lot of layout quirks that make it non-ideal for our documentation.
The original reasoning for beautiful-mermaid over the base mermaid package was the lack of SSR support from mermaid, but the lacklustre results are so much worse that the client-side JS feels justified.
There are projects to allow rendering mermaid statically at build time, but these involve playwright/puppeteer meaning an entire chromium instance runs and essentially screen-captures the rendered charts. There's some small progress on using svgdom, but I have not managed to get it to work.