fix: move mermaid script to before_closing_body_tag for proper rendering
#289
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
…ering Mermaid diagrams were rendering as code blocks instead of images because the script was loaded in the head tag before the DOM content was available. Moving to `before_closing_body_tag` ensures the script runs after all page content is loaded, allowing mermaid to find and transform the code blocks. Closes #287
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.
Summary
before_closing_head_tagtobefore_closing_body_tagProblem
Mermaid diagrams in hexdocs were rendering as code blocks instead of images because the script was loaded in the
<head>before the DOM content was available.Solution
ExDoc's
before_closing_body_tagoption ensures the script runs after all page content is loaded, allowing mermaid to find elements withclass="mermaid"and render them as diagrams.Closes #287
Test plan
mix check --no-retrypassesmix docsbuilds successfully</body>