Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mermaid 8.8.1 introduced a visual regression #468

Closed
thegiantbeast opened this issue Nov 8, 2021 · 7 comments · Fixed by #566
Closed

Mermaid 8.8.1 introduced a visual regression #468

thegiantbeast opened this issue Nov 8, 2021 · 7 comments · Fixed by #566
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@thegiantbeast
Copy link

Describe the bug
Just want to bring to your attention that mermaid 8.8.1 brought a visual regression described here, where basically leaves a huge top and bottom whitespace.

I guess this needs to be fixed at mermaid level but wanted to shared with the others if they ever face the same issue and not spending the time for finding the problem.

The current workaround would be to change the unpkg.com url from https://unpkg.com/mermaid/dist/mermaid.min.js to https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js.

@thegiantbeast
Copy link
Author

Forgot to relate with the mermaid issue: mermaid-js/mermaid#1984

@thegiantbeast
Copy link
Author

@kamiazya also, wouldn't it be better to somehow lock it into a version range? I'm just thinking that if mermaid decides to release a breaking change version, this will be picked up as the latest version and potentially break everyone code.

@kamiazya
Copy link
Owner

@thegiantbeast
Thank you for reporting!

If this plugin locks the version of mermaid, it is necessary to release plugin for each version upgrade of mermaid, and I'm afraid that the maintenance cost will increase.

I want to allow users to specify any mermaid version while maintaining the specification to use the latest mermaid version as a plugin.

How about this idea?

@kamiazya kamiazya added bug Something isn't working help wanted Extra attention is needed labels Nov 12, 2021
@thegiantbeast
Copy link
Author

@kamiazya that sounds great, so it gives the flexibility to specify the version for critical things and let it use the latest if not specified.

I will see if I find some time to open a PR for it.

@kamiazya
Copy link
Owner

@thegiantbeast

Perhaps addDeclaration method of the Options class is useful.

https://typedoc.org/api/classes/Options.html

I'm waiting for PR.

@kamiazya kamiazya added enhancement New feature or request and removed bug Something isn't working labels Nov 13, 2021
@kamiazya kamiazya pinned this issue Apr 6, 2022
@kamiazya
Copy link
Owner

kamiazya commented Apr 6, 2022

@thegiantbeast

I made a PullRequest #566.

I'm glad that your idea helped improve the library.


@all-contributors please add @thegiantbeast for ideas.

@allcontributors
Copy link
Contributor

@kamiazya

I've put up a pull request to add @thegiantbeast! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants