mermaid

Mermaid

This script provides support for rendering mermaid.js diagrams.

Documentation

Additional documentation can be found on the development wiki for this script.

Description

In the current version of this script, support for mermaid diagrams is made possible by using the mermaid.ink API. This renders mermaid diagrams in the QOwnNotes preview window by sending the mermaid code to the mermaid.ink online service, which generates an image URL that can be displayed directly.

Examples

A collection of examples can be found on the script development wiki here.

Limitations

As can be seen from the examples in the link above, not all diagrams render correctly (or at all). A known limitation of the mermaid.ink API is that diagrams that are too large (i.e., whose underlying code is too long after being base64 encoded) will not be rendered. This script should be considered a temporary workaround until full mermaid.js support can be provided.