-
Notifications
You must be signed in to change notification settings - Fork 903
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
Pull in latest mermaid version while allowing custom versions #1410
Conversation
Mermaid is at version 10.0.1 now, which is ESM only. |
This PR was reworked, mermaid script is now imported as module. This allows use use mermaid version 10 and above, right now we are at |
ac279e3
to
cbc57f9
Compare
a57fd66
to
c395c29
Compare
Rebased PR to HEAD of branch |
@chalin is this something we can pull in without disturbing the Great Bootstrap Upgrade? |
I've delayed addressing this PR because it feels like a one-off solution to something we might address as a more global solution to: |
eb6e107
to
e40937d
Compare
Can you be more specific please? What exactly is missing in my PR?
I had a look at #1354 again and I'm still on the impression that my PR covers all aspects discussed there. If I missed something however, please advise and I will happily extended and improve my PR so that it covers all desired aspects/functionalities. |
8bcfeeb
to
badb9fb
Compare
In the mean time packages are so outdated we cant do something as simple as document a diagram? Can this get merged in the mean time as it does not change things from a GDPR perspective. |
0ffc029
to
973fe1b
Compare
userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md
Outdated
Show resolved
Hide resolved
userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md
Outdated
Show resolved
Hide resolved
Updated user guide
Resolved the issues raised and updated documentation to latest mermaid version. From my point of view, this ready for merging. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
Making asset URL configurable was discussed more than once in the past. There was even PR #1006 that tried to resolve this issue, better never got merged due to CLA issues.
I myself proposed a solution on this issue with #803 a while ago. Yesterday @huima came up with a question about this issue again. This motivated me to author this PR which implements a quite simple solution for the outstanding issue: users now can simply specify the wanted mermaid version inside project's
hugo.yaml
:Everything else is transparently done behind the scenes. One can even specify
latest
in order to pull in the latest released version:This PR also adds a paragraph to the
mermaid
section of the user guide, documenting the newly introducedversion
parameter in themermaid
config section.This PR also contributes to #1354 (better GDPR support) in the sense that mermaid script is now pulled in at build time and not at runtime any more.
This PR currently addresses mermaid only. Should be fairly easy to extend this PR so that version of other dependencies (KaTeX, ...) can be specified inside
hugo.yaml
, too.This issue fixes #1484.
Preview: https://deploy-preview-1410--docsydocs.netlify.app/docs/adding-content/diagrams-and-formulae/#diagrams-with-mermaid