marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-16 05:49:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix: refactored documentation

Browse Source 
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
This commit is contained in:
omkarht
2025-08-19 14:53:08 +05:30
parent 0b42bdba07
commit 2b58df9665
3 changed files with 23 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/syntax/sequenceDiagram.md
View File

@@ -228,30 +228,30 @@ Lines can be solid or dotted, and can end with various types of arrowheads, cros
| `-)` | Solid line with an open arrow at the end (async) | | `-)` | Solid line with an open arrow at the end (async) |
| `--)` | Dotted line with a open arrow at the end (async) | | `--)` | Dotted line with a open arrow at the end (async) |
**New Half-Arrows** **Half-Arrows**
The following half-arrow types are now supported for more expressive sequence diagrams. Both solid and dotted variants are available by increasing the number of dashes (`-` → `--`). The following half-arrow types are now supported for more expressive sequence diagrams. Both solid and dotted variants are available by increasing the number of dashes (`-` → `--`).
--- ---
\| Type | Description | | Type | Description |
\| ------- | ---------------------------------------------------- | ---------------------------------------------- | | ------- | ---------------------------------------------------- |
\| `-\|\` | Solid line with top half arrowhead | | `-\|\` | Solid line with top half arrowhead |
\| `--\|\` | Dotted line with top half arrowhead | | `--\|\` | Dotted line with top half arrowhead |
\| `-\|/` | Solid line with bottom half arrowhead | | `-\|/` | Solid line with bottom half arrowhead |
\| `--\|/` | Dotted line with bottom half arrowhead | | `--\|/` | Dotted line with bottom half arrowhead |
\| `/\|-` | Solid line with reverse top half arrowhead | | `/\|-` | Solid line with reverse top half arrowhead |
\| `/\|--` | Dotted line with reverse top half arrowhead | | `/\|--` | Dotted line with reverse top half arrowhead |
\| `\\ | -` | Solid line with reverse bottom half arrowhead | | `\\-` | Solid line with reverse bottom half arrowhead |
\| `\\ | --` | Dotted line with reverse bottom half arrowhead | | `\\--` | Dotted line with reverse bottom half arrowhead |
\| `-\\` | Solid line with top stick half arrowhead | | `-\\` | Solid line with top stick half arrowhead |
\| `--\\` | Dotted line with top stick half arrowhead | | `--\\` | Dotted line with top stick half arrowhead |
\| `-//` | Solid line with bottom stick half arrowhead | | `-//` | Solid line with bottom stick half arrowhead |
\| `--//` | Dotted line with bottom stick half arrowhead | | `--//` | Dotted line with bottom stick half arrowhead |
\| `//-` | Solid line with reverse top stick half arrowhead | | `//-` | Solid line with reverse top stick half arrowhead |
\| `//--` | Dotted line with reverse top stick half arrowhead | | `//--` | Dotted line with reverse top stick half arrowhead |
\| `\\-` | Solid line with reverse bottom stick half arrowhead | | `\\-` | Solid line with reverse bottom stick half arrowhead |
\| `\\--` | Dotted line with reverse bottom stick half arrowhead | | `\\--` | Dotted line with reverse bottom stick half arrowhead |
## Central Connections ## Central Connections
@@ -280,24 +280,6 @@ sequenceDiagram
John()->>()Alice: Great! John()->>()Alice: Great!
``` ```
```mermaid-example
sequenceDiagram
participant Alice
participant John
Alice->>()John: Hello John
Alice()->>John: How are you?
John()->>()Alice: Great!
```
```mermaid
sequenceDiagram
participant Alice
participant John
Alice->>()John: Hello John
Alice()->>John: How are you?
John()->>()Alice: Great!
```
## Activations ## Activations
It is possible to activate and deactivate an actor. (de)activation can be dedicated declarations: It is possible to activate and deactivate an actor. (de)activation can be dedicated declarations:

1
packages/mermaid/src/diagrams/sequence/svgDraw.js
View File

@@ -1192,7 +1192,6 @@ export default {
getNoteRect, getNoteRect,
fixLifeLineHeights, fixLifeLineHeights,
sanitizeUrl, sanitizeUrl,
insertSolidTopArrowHead, insertSolidTopArrowHead,
insertSolidBottomArrowHead, insertSolidBottomArrowHead,
insertStickTopArrowHead, insertStickTopArrowHead,

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

@@ -163,22 +163,22 @@ Lines can be solid or dotted, and can end with various types of arrowheads, cros
| `-)` | Solid line with an open arrow at the end (async) | | `-)` | Solid line with an open arrow at the end (async) |
| `--)` | Dotted line with a open arrow at the end (async) | | `--)` | Dotted line with a open arrow at the end (async) |
**New Half-Arrows** **Half-Arrows**
The following half-arrow types are now supported for more expressive sequence diagrams. Both solid and dotted variants are available by increasing the number of dashes (`-` → `--`). The following half-arrow types are now supported for more expressive sequence diagrams. Both solid and dotted variants are available by increasing the number of dashes (`-` → `--`).
--- ---
| Type | Description | | Type | Description |
| ------- | ---------------------------------------------------- | ---------------------------------------------- | | ------- | ---------------------------------------------------- |
| `-\|\` | Solid line with top half arrowhead | | `-\|\` | Solid line with top half arrowhead |
| `--\|\` | Dotted line with top half arrowhead | | `--\|\` | Dotted line with top half arrowhead |
| `-\|/` | Solid line with bottom half arrowhead | | `-\|/` | Solid line with bottom half arrowhead |
| `--\|/` | Dotted line with bottom half arrowhead | | `--\|/` | Dotted line with bottom half arrowhead |
| `/\|-` | Solid line with reverse top half arrowhead | | `/\|-` | Solid line with reverse top half arrowhead |
| `/\|--` | Dotted line with reverse top half arrowhead | | `/\|--` | Dotted line with reverse top half arrowhead |
| `\\ | -` | Solid line with reverse bottom half arrowhead | | `\\-` | Solid line with reverse bottom half arrowhead |
| `\\ | --` | Dotted line with reverse bottom half arrowhead | | `\\--` | Dotted line with reverse bottom half arrowhead |
| `-\\` | Solid line with top stick half arrowhead | | `-\\` | Solid line with top stick half arrowhead |
| `--\\` | Dotted line with top stick half arrowhead | | `--\\` | Dotted line with top stick half arrowhead |
| `-//` | Solid line with bottom stick half arrowhead | | `-//` | Solid line with bottom stick half arrowhead |
@@ -206,15 +206,6 @@ sequenceDiagram
John()->>()Alice: Great! John()->>()Alice: Great!
``` ```
```mermaid
sequenceDiagram
participant Alice
participant John
Alice->>()John: Hello John
Alice()->>John: How are you?
John()->>()Alice: Great!
```
## Activations ## Activations
It is possible to activate and deactivate an actor. (de)activation can be dedicated declarations: It is possible to activate and deactivate an actor. (de)activation can be dedicated declarations: