feat: add support for @mermaid-js/mermaid-zenuml #566
Merged
Conversation
This file contains 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
|
Thank you! :) |
|
Please, resolve the merge conflicts and let's merge it 😄 |
Mermaid now has support for ZenUML diagrams, but it requires using a Mermaid plugin diagram, see https://mermaid.js.org/syntax/zenuml.html ZenUML adds about 700 KiB to our `dist/index.html` file, or about 200 KiB when gzipped.
Limit antlr4 to `~4.11.0` to support Node v14. antlr4 `4.12.0` drops Node.JS v14 support, see antlr/antlr4@2c75e64
aloisklink
force-pushed
the
feat/support-mermaid-zenuml
branch
from
0288147
to
87aac7b
Compare
|
I've rebased on to Hmmmm, the generated ZenUML
Do you think this is okay to merge? My gut feeling is yes, since having an image is better than having no image, and users can always use something like imagemaick's |
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
Mermaid now has support for ZenUML diagrams, but it requires using a Mermaid plugin diagram, see https://mermaid.js.org/syntax/zenuml.html
ZenUML adds about 700 KiB to our
dist/index.htmlfile, or about 200 KiB when gzipped.Resolves #564
📏 Design Decisions
Adding support for ZenUML diagrams is just like how we previously added support for mindmap diagrams in PR #424, so please see discussion in that PR for design decisions.
By the way, I had to manually limit the version of
antlr4to~4.11.0, since v4.12.0 (in commit antlr/antlr4@2c75e64) drops NodeJS v14 support.New size of mermaid-cli package:
ZenUML adds about 700 KiB to our
dist/index.htmlfile, or about 200 KiB when gzipped. Additionally, it takes about 2.5 seconds longer to build thedist/index.htmlfile, about a 25% increase.Currently
After adding
@mermaid-js/mermaid-zenuml📋 Tasks
Make sure you
test-positive/zenuml.mmdmasterbranch