search

fralau / mkdocs-mermaid2-plugin

A Mermaid graphs plugin for mkdocs
https://mkdocs-mermaid2.readthedocs.io
MIT License
203 stars 25 forks source link

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

Open fralau opened 1 year ago

fralau commented 1 year ago

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 commented 11 months ago

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 commented 10 months ago

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.