Coder Social home page Coder Social logo

Comments (5)

alexvoss avatar alexvoss commented on June 14, 2024

As I mentioned a moment ago in the discussion, Material for MkDocs uses its own integration with Mermaid. What may need to be changed in the documentation is to add a sentence that clearly states that the integration via the plugin is different?

from mkdocs-material.

kamilkrzyskow avatar kamilkrzyskow commented on June 14, 2024

Issues with the mermaid2-plugin should be reported upstream to it:

But we probably should make a note about it in the documentation that the plugin is provided separate functionality 🤔

from mkdocs-material.

squidfunk avatar squidfunk commented on June 14, 2024

We don't mention the plugin anywhere and explicitly say that SuperFences is the only necessary configuration. I did not want to keep people from using other plugins though, which a "don't install plugin X" note would do. If you have a better idea, I'm happy to discuss. Closing as upstream.

from mkdocs-material.

kamilkrzyskow avatar kamilkrzyskow commented on June 14, 2024

Further discussion in the linked discussion has led to a new discovery that the user might be running index.html from the filesystem and the default mermaid logic doesn't work then, he still needs to get back to us, might not be an upstream issue after all 😆

from mkdocs-material.

squidfunk avatar squidfunk commented on June 14, 2024

IIRC, Mermaid.js should work offline, but instant navigation will not.

from mkdocs-material.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.