Repository navigation
chore(site): render mermaid diagrams - #20
Merged
Merged
Conversation
Draw mermaid fences as diagrams in the browser, so that guides can keep sequence and set-up diagrams as text next to the prose they explain. Mermaid is imported only on pages that have a diagram, because vitepress-plugin-mermaid adds about 2 MB of script to every page, and mermaid.ink would send each diagram to an outside service. No wire effect: only the documentation site changes. Assisted-by: Claude-Code:claude-opus-5-5 Signed-off-by: Stephen Reedy <sreedy@riis.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
2 participants
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.
The docs site now draws
mermaidcode fences as diagrams, so message exchanges and set-ups can live as sequence diagrams next to the prose that explains them. Mermaid loads only on pages that have a diagram, wide diagrams scroll sideways at their natural size instead of shrinking, anddocs/en/contributing.mdsays how to write them. Wire impact: none, only the documentation site changes.vitepress-plugin-mermaidwould add about 2 MB of script to every page, and mermaid.ink images would send each diagram to an outside service, so neither is used. The site stays on mermaid 11; moving to 12 is a separate PR.Assisted-by: Claude-Code:claude-opus-5-5