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

By default, take the latest version of mermaid library? #66

Open
fralau opened this issue Jan 7, 2023 · 3 comments
Open

By default, take the latest version of mermaid library? #66

fralau opened this issue Jan 7, 2023 · 3 comments
Labels
help wanted Extra attention is needed

Comments

@fralau
Copy link
Owner

fralau commented Jan 7, 2023

Currently, mkdocs-mermaid2 seems to take by default the MERMAID_LIB_VERSION.

We could also use an approach where it takes the latest version of the mermaid library by default.

It happened once in the past, that the latest version was problematic, and it broke the build. Which is why we wanted to keep control on the 'recommended' (stable) version

We could have a compromise solution?

@fralau fralau added the help wanted Extra attention is needed label Jul 12, 2023
@fralau
Copy link
Owner Author

fralau commented Aug 4, 2023

One solution could be to get the latest release from github (see how to do this in Python).

Put it could be that the simplest option is to update the library version number as we go.

@fralau
Copy link
Owner Author

fralau commented Sep 3, 2023

So far, it seems that updating progressively the reference version of mermaid.js is still the best thing. This gives a better guarantee that the Mkdocs-Mermaid2 package will continue to work. In any case, it is possible to change the javascript library's version with the version parameter in the config file; or even (new in 1.1.0) to provide the URL.

@SLoeuillet
Copy link

using plugin 1.1.1,

plugins:
  - mermaid2:
      version: 11.2.0

Works :

INFO    -  MERMAID2  - Initialization arguments: {'securityLevel': 'loose'}
INFO    -  MERMAID2  - Using javascript library (11.2.0):
              https://unpkg.com/[email protected]/dist/mermaid.esm.min.mjs

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

No branches or pull requests

2 participants