marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-08-15 06:19:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: updated documentation for new syntax

Browse Source 
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
This commit is contained in:
omkarht
2025-08-08 13:30:00 +05:30
parent bf362673fc
commit fb6ace73b5
2 changed files with 138 additions and 138 deletions
Download Patch File Download Diff File Expand all files Collapse all files

180
docs/syntax/sequenceDiagram.md
View File

@@ -76,218 +76,218 @@ sequenceDiagram
### Boundary ### Boundary
If you want to use the boundary symbol for a participant, use the `boundary` statement as shown below. If you want to use the boundary symbol for a participant, use the JSON configuration syntax as shown below.
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
boundary theBoundary participant Alice@{ "type" : "boundary" }
participant Bob participant Bob
theBoundary->>Bob: Request from boundary Alice->>Bob: Request from boundary
Bob->>theBoundary: Response to boundary Bob->>Alice: Response to boundary
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
boundary theBoundary participant Alice@{ "type" : "boundary" }
participant Bob participant Bob
theBoundary->>Bob: Request from boundary Alice->>Bob: Request from boundary
Bob->>theBoundary: Response to boundary Bob->>Alice: Response to boundary
``` ```
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
boundary theBoundary participant Alice@{ "type" : "boundary" }
participant Bob participant Bob
theBoundary->>Bob: Request from boundary Alice->>Bob: Request from boundary
Bob->>theBoundary: Response to boundary Bob->>Alice: Response to boundary
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
boundary theBoundary participant Alice@{ "type" : "boundary" }
participant Bob participant Bob
theBoundary->>Bob: Request from boundary Alice->>Bob: Request from boundary
Bob->>theBoundary: Response to boundary Bob->>Alice: Response to boundary
``` ```
### Control ### Control
If you want to use the control symbol for a participant, use the `control` statement as shown below. If you want to use the control symbol for a participant, use the JSON configuration syntax as shown below.
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
control theControl participant Alice@{ "type" : "control" }
participant Alice participant Bob
theControl->>Alice: Control request Alice->>Bob: Control request
Alice->>theControl: Control response Bob->>Alice: Control response
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
control theControl participant Alice@{ "type" : "control" }
participant Alice participant Bob
theControl->>Alice: Control request Alice->>Bob: Control request
Alice->>theControl: Control response Bob->>Alice: Control response
``` ```
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
control theControl participant Alice@{ "type" : "control" }
participant Alice participant Bob
theControl->>Alice: Control request Alice->>Bob: Control request
Alice->>theControl: Control response Bob->>Alice: Control response
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
control theControl participant Alice@{ "type" : "control" }
participant Alice participant Bob
theControl->>Alice: Control request Alice->>Bob: Control request
Alice->>theControl: Control response Bob->>Alice: Control response
``` ```
### Entity ### Entity
If you want to use the entity symbol for a participant, use the `entity` statement as shown below. If you want to use the entity symbol for a participant, use the JSON configuration syntax as shown below.
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
entity theEntity participant Alice@{ "type" : "entity" }
participant Bob participant Bob
theEntity->>Bob: Entity request Alice->>Bob: Entity request
Bob->>theEntity: Entity response Bob->>Alice: Entity response
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
entity theEntity participant Alice@{ "type" : "entity" }
participant Bob participant Bob
theEntity->>Bob: Entity request Alice->>Bob: Entity request
Bob->>theEntity: Entity response Bob->>Alice: Entity response
``` ```
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
entity theEntity participant Alice@{ "type" : "entity" }
participant Bob participant Bob
theEntity->>Bob: Entity request Alice->>Bob: Entity request
Bob->>theEntity: Entity response Bob->>Alice: Entity response
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
entity theEntity participant Alice@{ "type" : "entity" }
participant Bob participant Bob
theEntity->>Bob: Entity request Alice->>Bob: Entity request
Bob->>theEntity: Entity response Bob->>Alice: Entity response
``` ```
### Database ### Database
If you want to use the database symbol for a participant, use the `database` statement as shown below. If you want to use the database symbol for a participant, use the JSON configuration syntax as shown below.
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
database theDb participant Alice@{ "type" : "database" }
participant Alice participant Bob
theDb->>Alice: DB query Alice->>Bob: DB query
Alice->>theDb: DB result Bob->>Alice: DB result
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
database theDb participant Alice@{ "type" : "database" }
participant Alice participant Bob
theDb->>Alice: DB query Alice->>Bob: DB query
Alice->>theDb: DB result Bob->>Alice: DB result
``` ```
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
database theDb participant Alice@{ "type" : "database" }
participant Alice participant Bob
theDb->>Alice: DB query Alice->>Bob: DB query
Alice->>theDb: DB result Bob->>Alice: DB result
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
database theDb participant Alice@{ "type" : "database" }
participant Alice participant Bob
theDb->>Alice: DB query Alice->>Bob: DB query
Alice->>theDb: DB result Bob->>Alice: DB result
``` ```
### Collections ### Collections
If you want to use the collections symbol for a participant, use the `collections` statement as shown below. If you want to use the collections symbol for a participant, use the JSON configuration syntax as shown below.
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
collections theCollection participant Alice@{ "type" : "collections" }
participant Bob participant Bob
theCollection->>Bob: Collections request Alice->>Bob: Collections request
Bob->>theCollection: Collections response Bob->>Alice: Collections response
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
collections theCollection participant Alice@{ "type" : "collections" }
participant Bob participant Bob
theCollection->>Bob: Collections request Alice->>Bob: Collections request
Bob->>theCollection: Collections response Bob->>Alice: Collections response
``` ```
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
collections theCollection participant Alice@{ "type" : "collections" }
participant Bob participant Bob
theCollection->>Bob: Collections request Alice->>Bob: Collections request
Bob->>theCollection: Collections response Bob->>Alice: Collections response
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
collections theCollection participant Alice@{ "type" : "collections" }
participant Bob participant Bob
theCollection->>Bob: Collections request Alice->>Bob: Collections request
Bob->>theCollection: Collections response Bob->>Alice: Collections response
``` ```
### Queue ### Queue
If you want to use the queue symbol for a participant, use the `queue` statement as shown below. If you want to use the queue symbol for a participant, use the JSON configuration syntax as shown below.
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
queue theQueue participant Alice@{ "type" : "queue" }
participant Alice participant Bob
theQueue->>Alice: Queue message Alice->>Bob: Queue message
Alice->>theQueue: Queue Bob->>Alice: Queue response
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
queue theQueue participant Alice@{ "type" : "queue" }
participant Alice participant Bob
theQueue->>Alice: Queue message Alice->>Bob: Queue message
Alice->>theQueue: Queue Bob->>Alice: Queue response
``` ```
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
queue theQueue participant Alice@{ "type" : "queue" }
participant Alice participant Bob
theQueue->>Alice: Queue message Alice->>Bob: Queue message
Alice->>theQueue: Queue Bob->>Alice: Queue response
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
queue theQueue participant Alice@{ "type" : "queue" }
participant Alice participant Bob
theQueue->>Alice: Queue message Alice->>Bob: Queue message
Alice->>theQueue: Queue Bob->>Alice: Queue response
``` ```
### Aliases ### Aliases

96
packages/mermaid/src/docs/syntax/sequenceDiagram.md
View File

@@ -48,122 +48,122 @@ sequenceDiagram
### Boundary ### Boundary
If you want to use the boundary symbol for a participant, use the `boundary` statement as shown below. If you want to use the boundary symbol for a participant, use the JSON configuration syntax as shown below.
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
boundary theBoundary participant Alice@{ "type" : "boundary" }
participant Bob participant Bob
theBoundary->>Bob: Request from boundary Alice->>Bob: Request from boundary
Bob->>theBoundary: Response to boundary Bob->>Alice: Response to boundary
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
boundary theBoundary participant Alice@{ "type" : "boundary" }
participant Bob participant Bob
theBoundary->>Bob: Request from boundary Alice->>Bob: Request from boundary
Bob->>theBoundary: Response to boundary Bob->>Alice: Response to boundary
``` ```
### Control ### Control
If you want to use the control symbol for a participant, use the `control` statement as shown below. If you want to use the control symbol for a participant, use the JSON configuration syntax as shown below.
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
control theControl participant Alice@{ "type" : "control" }
participant Alice participant Bob
theControl->>Alice: Control request Alice->>Bob: Control request
Alice->>theControl: Control response Bob->>Alice: Control response
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
control theControl participant Alice@{ "type" : "control" }
participant Alice participant Bob
theControl->>Alice: Control request Alice->>Bob: Control request
Alice->>theControl: Control response Bob->>Alice: Control response
``` ```
### Entity ### Entity
If you want to use the entity symbol for a participant, use the `entity` statement as shown below. If you want to use the entity symbol for a participant, use the JSON configuration syntax as shown below.
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
entity theEntity participant Alice@{ "type" : "entity" }
participant Bob participant Bob
theEntity->>Bob: Entity request Alice->>Bob: Entity request
Bob->>theEntity: Entity response Bob->>Alice: Entity response
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
entity theEntity participant Alice@{ "type" : "entity" }
participant Bob participant Bob
theEntity->>Bob: Entity request Alice->>Bob: Entity request
Bob->>theEntity: Entity response Bob->>Alice: Entity response
``` ```
### Database ### Database
If you want to use the database symbol for a participant, use the `database` statement as shown below. If you want to use the database symbol for a participant, use the JSON configuration syntax as shown below.
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
database theDb participant Alice@{ "type" : "database" }
participant Alice participant Bob
theDb->>Alice: DB query Alice->>Bob: DB query
Alice->>theDb: DB result Bob->>Alice: DB result
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
database theDb participant Alice@{ "type" : "database" }
participant Alice participant Bob
theDb->>Alice: DB query Alice->>Bob: DB query
Alice->>theDb: DB result Bob->>Alice: DB result
``` ```
### Collections ### Collections
If you want to use the collections symbol for a participant, use the `collections` statement as shown below. If you want to use the collections symbol for a participant, use the JSON configuration syntax as shown below.
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
collections theCollection participant Alice@{ "type" : "collections" }
participant Bob participant Bob
theCollection->>Bob: Collections request Alice->>Bob: Collections request
Bob->>theCollection: Collections response Bob->>Alice: Collections response
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
collections theCollection participant Alice@{ "type" : "collections" }
participant Bob participant Bob
theCollection->>Bob: Collections request Alice->>Bob: Collections request
Bob->>theCollection: Collections response Bob->>Alice: Collections response
``` ```
### Queue ### Queue
If you want to use the queue symbol for a participant, use the `queue` statement as shown below. If you want to use the queue symbol for a participant, use the JSON configuration syntax as shown below.
```mermaid-example ```mermaid-example
sequenceDiagram sequenceDiagram
queue theQueue participant Alice@{ "type" : "queue" }
participant Alice participant Bob
theQueue->>Alice: Queue message Alice->>Bob: Queue message
Alice->>theQueue: Queue Bob->>Alice: Queue response
``` ```
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
queue theQueue participant Alice@{ "type" : "queue" }
participant Alice participant Bob
theQueue->>Alice: Queue message Alice->>Bob: Queue message
Alice->>theQueue: Queue Bob->>Alice: Queue response
``` ```
### Aliases ### Aliases