Add support for lazyLoadedDiagrams (mermaid v9.2.0)
#420
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
Bumps [mermaid](https://github.com/mermaid-js/mermaid) from 9.1.7 to 9.2.0. - [Release notes](https://github.com/mermaid-js/mermaid/releases) - [Commits][1] [1]: mermaid-js/mermaid@9.1.7...9.2.0 The tests needed to be modified slightly, since the following error is now thrown for our invalid mermaid file test: ``` Error: No diagram type detected for text: ... ``` Some other features (e.g. `lazyLoadedDiagrams`) will be fixed in future commits. Co-authored-by: Mindaugas Laganeckas <mindaugas.laganeckas@gmail.com>
Mermaid v9.2.0 added support for custom diagrams using `lazyLoadedDiagrams`, such as the new [@mermaid-js/mermaid-mindmap][1] plugin diagram. [1]: https://www.npmjs.com/package/@mermaid-js/mermaid-mindmap
Move test fixtures into a `test/__fixtures__` folder.
Previously, all of the Node.JS workflows were ignoring the `config.json` file.
aloisklink
added
dependencies
|
Thank you for your help @aloisklink ! And excellent work!! Approved! |
MindaugasLaganeckas
approved these changes
Nov 9, 2022
This was referenced Nov 9, 2022
Closed
|
I'm closing this, it sounds like I might |
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 v9.2.0 added support for custom diagrams using
lazyLoadedDiagrams, such as the new @mermaid-js/mermaid-mindmap plugin diagram.This PR bumps the minimum required version of mermaid to v9.2.0, adds support for
lazyLoadedDiagrams(needed to switch the Mermaid rendering code toasync) and adds some test cases/docs.Resolves #406
📏 Design Decisions
mermaid-mindmapis opt-in (disabled by default), since I couldn't get it to work locally, due to puppeteer CORS issues.Instead, currently it only works when hosted from a CDN like https://www.jsdelivr.com/, so it requires internet connection (and there are some GDPR issues with enabling it by default, since jsdeliver has a privacy policy).
In order to get mermaid-mindmap working locally/offline, I think we need mermaid-js/mermaid#3710 to be merged first, then we can bundle it together into a single
index.htmlfile.Also, to make adding
mermaid-mindmaptest cases easier, I've moved all of the test cases into atest/__fixtures__/...folder.📋 Tasks
Make sure you
masterbranch