Render Mermaid diagrams in exported HTML - #1173
Closed
YoshihideShirai wants to merge 3 commits into
Closed
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
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.
What changed
This renders Mermaid diagrams during HTML export by converting generated
<pre class="mermaid">blocks into embedded SVG before the HTML is written.The export path now reuses Mermaid in a Node/JSDOM environment, keeps Mermaid's strict security level, and only runs this extra rendering step for the
html5backend. A focused unit test covers the exported HTML transformation.Why
Fixes #1170. In v4, the VS Code preview initializes Mermaid in the webview, but exported HTML is static and did not include a Mermaid renderer or pre-rendered diagram output. As a result, Mermaid blocks exported as raw
<pre class="mermaid">elements and stayed blank in a browser.Validation
npm install --package-lock-only --ignore-scriptsnpm run lintnpm run format && git diff --exit-codenpm run typechecknpm run build-testnpm run test:unit