Support mermaid diagrams

• Overview
• Rationale
• Encountered issues
  • Mermaid Python plugin
• References

Overview

Add support for Mermaid JS diagrams.

Rationale

Mermaid diagrams offer a convenient solution for embedding graphic contents while supporting revision control (diff'ing) capabilities.

Encountered issues

Mermaid Python plugin

The default configuration of mkdocs on the runner does not natively provides the Memaid JS plugin.

$ mkdocs build --verbose
 (...)
ERROR    -  Config value: 'plugins'. Error: The "mermaid2" plugin is not installed

References

• Matching issue for the Hugo site generator.
• https://mkdocs-mermaid2.readthedocs.io/en/latest/
• https://squidfunk.github.io/mkdocs-material/reference/diagrams/
• https://blog.kellenbaker.com/add-mermaid-js-to-mkdocs