Skip to main content

Using mermaid

EventCatalog supports mermaid in all your markdown files.

Using mermaid​

To use mermaid you need to use the mermaid code block.

Example​

```mermaid
sequenceDiagram
    participant Customer
    participant OrdersService
    participant InventoryService
    participant NotificationService

    Customer->>OrdersService: Place Order
    OrdersService->>InventoryService: Check Inventory
    InventoryService-->>OrdersService: Inventory Available
    OrdersService->>InventoryService: Reserve Inventory
    OrdersService->>NotificationService: Send Order Confirmation
    NotificationService-->>Customer: Order Confirmation
    OrdersService->>Customer: Order Placed Successfully
    OrdersService->>InventoryService: Update Inventory
```_

This example will output the following in the markdown file.

Example output of mermaid

More examples​

You can find examples of mermaid on this website.