Skip to main content
⭐️ If you love EventCatalog, give it a star on GitHub. Thanks!

Using mermaid

EventCatalog supports mermaid in all your markdown files.

Using mermaid

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


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.