Repository navigation
docs: the dialect diagrams render on GitHub - #33
Merged
Merged
Conversation
GitHub decodes HTML entities before it hands a diagram to Mermaid, so the " in docs/dialects.md's checking diagram reached Mermaid as a quote that ended its label: a parse error on GitHub, and a diagram in every renderer that leaves the entity alone, which is how it was checked. The labels use Mermaid's own codes (#quot;, #gt;), which GitHub leaves alone, in dialects.md, error-handling.md and filtering.md. All 21 diagrams were rendered after GitHub's decoding, which reproduced the failure on main. TestNoDiagramUsesAnHTMLEntity refuses an entity in a diagram. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
docs/dialects.md's checking diagram showed a parse error on GitHub:Why: GitHub decodes HTML entities before it hands a diagram to Mermaid. The label's
"reached Mermaid as a real", which ended the label. The renderer I checked it with leaves entities alone, so it rendered there.Fix:
#quot;,#gt;), which GitHub leaves alone and Mermaid decodes. That coversdialects.md(the broken one), anderror-handling.mdandfiltering.md(their>sat inside quoted labels and did not break them, but it is the same pattern).TestNoDiagramUsesAnHTMLEntityfails on any HTML entity inside a Mermaid block in the README ordocs/. It fails onmain'sdialects.md, which was tested.Checked: every diagram, 21 of them, rendered after GitHub-style entity decoding (
html.unescape, then mermaid-cli). That reproduced the failure onmain's diagram and shows all 21 rendering now.This goes into
v1.2.0, which is not tagged yet.🤖 Generated with Claude Code