Diagrams in MyST¶

The MyST forms of the specimens on Diagrams, each rendered live by this page’s own Markdown parser.

Mermaid¶

A Mermaid diagram

```{mermaid}
:caption: Firmware boot sequence

sequenceDiagram
    Bootloader->>Firmware: verify signature
    Firmware-->>Bootloader: ok
```

        sequenceDiagram
    Bootloader->>Firmware: verify signature
    Firmware-->>Bootloader: ok

Firmware boot sequence¶

A Mermaid diagram from a file

```{mermaid} /../specimens/diagrams/boot.mmd
```

        sequenceDiagram
    Bootloader->>Firmware: load image
    Firmware-->>Bootloader: ready

A sequence diagram

```{uml}
@startuml
Alice -> Bob: Hello
Bob --> Alice: Hi
@enduml
```

A class diagram

```{plantuml}
:caption: Classes of the greeter

@startuml
class Greeter {
  +greet(name)
}
class Farewell
Greeter --> Farewell
@enduml
```

A preprocessed diagram

```{uml}
@startuml
!$first = "Bob"
!procedure $hello($to)
Alice -> $to: Hello
!endprocedure
$hello($first)
$hello("Carol")
@enduml
```