How to enable mindmaps from mermaid library?

[andynameistaken]

This is what I've tried:

• added to mkdocs.yml
  a)

markdown_extensions:
 - pymdownx.superfences:
     custom_fences:
       - name: mermaid
         class: mermaid
         format: !!python/name:pymdownx.superfences.fence_code_format

b) Because mindmap library uses the lazy loading:

extra_javascript:
  - https://cdn.jsdelivr.net/npm/[email protected]/dist/mermaid.esm.min.mjs
  - https://cdn.jsdelivr.net/npm/@mermaid-js/[email protected]/dist/mermaid-mindmap.esm.min.mjs

• created sample page

This is the result I've got (syntax is correct):

[squidfunk]

I suspect the problem is that currently, (Material for) MkDocs doesn't properly treat .mjs files as JavaScript. You would need to open a change request upstream, as support would need to be added to MkDocs, then we can add it here.

[CheziSpero]

Hi!
Seems like mkdocs solved the issue regarding mjs files, but it still seems like mindmaps don't work. Am I missing something? 🤔

[squidfunk]

Still blocked by #5758 😅

[andynameistaken]

Thanks, I'll ask them if they want to. Anyway, have you considered forking MkDocs? I thought if it might be easier to develop features that way, while still keeping track of core changes.

[squidfunk]

Forking MkDocs would not be a good idea, since we might break compatibility with existing plugins. Changes should be implemented upstream. I really hope that MkDocs will see some more active development in the future, but I just can't do it myself — I already invest most of my time I have to work on Open Source into this project. Luckily, MkDocs is pretty well designed, so that you can achieve most of the changes through its plugin system. This change however would need to be implemented in core.

[facelessuser]

Yeah, MkDocs is going to have to consider how to handle ems modules moving forward. Mermaid 9.4.0 is the last major version it looks like that will support cjs. 10 uses modules and changes how rendering works and is now async. As things are now, Material can safely support up to 9.4.0, but I imagine at some future time, support for 10 will maybe need to be considered. I'm personally in no hurry to worry about Mermaid 10 right now, but something to be thinking about for the future.

[andynameistaken]

Cool, I'll try to learn how MkDocs works so in the future I can submit PR with feature provided as I'm using your project quite extensievely and maybe that would be like saying thank you.