How to contribute

Guidance

1. Contributions are welcome.
2. Before submitting an issue, consider this documentation, and particularly the troubleshooting section.
3. Use the Issues to signal a bug or propose a feature you believe is necessary.
4. If this is a usage question, prefer the discussions.
5. Before submitting a PR, always open an Issue and consider the answers.
6. As a rule, changes get a new version number; they are first pushed on github, and then deployed on pypi.

Making a distinction between the software components

When assessing issues or bugs, it is important to understand which components are involved.

graph TD

    subgraph plugins
    mkdocs-mermaid["Mkdocs-Mermaid2"]
    end

    subgraph browser["Browser"]
    rendering[/"HTML/css/Javascript engine"\]
    html(HTML) ==> rendering
    css(css) ==> rendering
    javascript(Javascript) ==> rendering
    end

    subgraph main
    mkdocs["MkDocs*"] -- generates --> html
    mkdocs -- generates --> javascript
    end

    mkdocs-mermaid -.plugin of.-> mkdocs
    mkdocs -.-> Material
    mkdocs -.extra_javascript.-> mermaid
    Superfences -- custom fence --> mermaid



    subgraph libraries["Javascript libraries"]
    mermaid[Mermaid.js*]  -- provides --> javascript 
    end

    subgraph extensions["Markdown extensions"]
    mkdocs -.markdown_extensions.-> Superfences
    Superfences["Superfences*"]
    end

    subgraph themes
    Material[Material*] -- provides --> css 
    Material --> html2("HTML (templates)") --> html
    end



    click mkdocs "https://www.mkdocs.org/" _blank
    click Material "https://squidfunk.github.io/mkdocs-material/" _blank
    click Superfences "https://facelessuser.github.io/pymdown-extensions/extensions/superfences/" _blank
    click mermaid "https://mermaid.js.org/intro/" _blank

Credits

mkdocs-mermaid2 is a fork from Pugong Liu's excellent project, which is no longer maintained. This new plugin offers expanded documentation as well as new functions.

It is also compatible with versions of the mermaid library > 10.0.

Thanks to all the members of the community who participated to the improvement of this project with ideas and PRs.