feat: add beautiful-mermaid as optional mermaid renderer#366
Open
dermorz wants to merge 1 commit intobrianhuster:mainfrom
Open
feat: add beautiful-mermaid as optional mermaid renderer#366dermorz wants to merge 1 commit intobrianhuster:mainfrom
dermorz wants to merge 1 commit intobrianhuster:mainfrom
Conversation
Add configurable mermaid renderer option supporting both default
mermaid.js and beautiful-mermaid for improved aesthetics.
- Add mermaid.renderer ("default" | "beautiful") config option
- Add mermaid.theme config option for beautiful-mermaid themes
- Bundle beautiful-mermaid.js for offline use
- Update template to conditionally load renderer
- Update client to use selected renderer
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.
Summary
Adds support for beautiful-mermaid as an alternative to the default mermaid.js renderer for rendering diagrams in Markdown and AsciiDoc files.
Changes
mermaid.rendererconfig option ("default"or"beautiful")mermaid.themeconfig option for beautiful-mermaid themesUsage
Available beautiful-mermaid themes:
zinc-light,zinc-dark,tokyo-night,tokyo-night-storm,tokyo-night-light,catppuccin-mocha,catppuccin-latte,nord,nord-light,dracula,github-light,github-dark,solarized-light,solarized-dark,one-dark.Note
beautiful-mermaid supports 6 diagram types (flowchart, state, sequence, class, ER, xychart). Some mermaid.js diagrams may not render with this renderer.
Breaking Changes
None - defaults to existing mermaid.js renderer.