Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 999 Bytes

mermaid.rst

File metadata and controls

42 lines (29 loc) · 999 Bytes

Mermaid diagrams

About

Mermaid is a JavaScript based diagramming and charting tool that renders Markdown- inspired text definitions to create and modify diagrams dynamically.

By adding a mermaid directive, the sphinxcontrib-mermaid extension allows you to embed Mermaid graphs in your documents, including general flowcharts, sequence diagrams, gantt diagrams, and more.

The most popular chart will probably be a flowchart, see Flowcharts - Basic Syntax for an introduction.

Examples

Sequence diagram

.. mermaid::

    sequenceDiagram
      participant Alice
      participant Bob
      Alice->John: Hello John, how are you?

Flowchart diagram

.. mermaid:: ../_static/mermaid-example.mmd