Skip to content

Commit

Permalink
Merge branch 'master' into develop
Browse files Browse the repository at this point in the history
* master:
  Update flowchart.md (#4798)
  chore: Fix warning formatting
  docs: Disable showValues in sankey example
  • Loading branch information
sidharthv96 committed Sep 6, 2023
2 parents 773abbe + 2eb9afa commit c12deca
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 11 deletions.
8 changes: 4 additions & 4 deletions docs/syntax/flowchart.md
Expand Up @@ -860,8 +860,8 @@ flowchart LR
C-->D
click A callback "Tooltip for a callback"
click B "https://www.github.com" "This is a tooltip for a link"
click A call callback() "Tooltip for a callback"
click B href "https://www.github.com" "This is a tooltip for a link"
click C call callback() "Tooltip for a callback"
click D href "https://www.github.com" "This is a tooltip for a link"
```

```mermaid
Expand All @@ -871,8 +871,8 @@ flowchart LR
C-->D
click A callback "Tooltip for a callback"
click B "https://www.github.com" "This is a tooltip for a link"
click A call callback() "Tooltip for a callback"
click B href "https://www.github.com" "This is a tooltip for a link"
click C call callback() "Tooltip for a callback"
click D href "https://www.github.com" "This is a tooltip for a link"
```

> **Success** The tooltip functionality and the ability to link to urls are available from version 0.5.2.
Expand Down
15 changes: 12 additions & 3 deletions docs/syntax/sankey.md
Expand Up @@ -8,9 +8,8 @@

> A sankey diagram is a visualization used to depict a flow from one set of values to another.
::: warning
This is an experimental diagram. Its syntax are very close to plain CSV, but it is to be extended in the nearest future.
:::
> **Warning**
> This is an experimental diagram. Its syntax are very close to plain CSV, but it is to be extended in the nearest future.
The things being connected are called nodes and the connections are called links.

Expand All @@ -19,6 +18,11 @@ The things being connected are called nodes and the connections are called links
This example taken from [observable](https://observablehq.com/@d3/sankey/2?collection=@d3/d3-sankey). It may be rendered a little bit differently, though, in terms of size and colors.

```mermaid-example
---
config:
sankey:
showValues: false
---
sankey-beta
Agricultural 'waste',Bio-conversion,124.729
Expand Down Expand Up @@ -92,6 +96,11 @@ Wind,Electricity grid,289.366
```

```mermaid
---
config:
sankey:
showValues: false
---
sankey-beta
Agricultural 'waste',Bio-conversion,124.729
Expand Down
4 changes: 2 additions & 2 deletions packages/mermaid/src/docs/syntax/flowchart.md
Expand Up @@ -554,8 +554,8 @@ flowchart LR
C-->D
click A callback "Tooltip for a callback"
click B "https://www.github.com" "This is a tooltip for a link"
click A call callback() "Tooltip for a callback"
click B href "https://www.github.com" "This is a tooltip for a link"
click C call callback() "Tooltip for a callback"
click D href "https://www.github.com" "This is a tooltip for a link"
```

> **Success** The tooltip functionality and the ability to link to urls are available from version 0.5.2.
Expand Down
9 changes: 7 additions & 2 deletions packages/mermaid/src/docs/syntax/sankey.md
Expand Up @@ -2,9 +2,9 @@

> A sankey diagram is a visualization used to depict a flow from one set of values to another.
::: warning
```warning
This is an experimental diagram. Its syntax are very close to plain CSV, but it is to be extended in the nearest future.
:::
```

The things being connected are called nodes and the connections are called links.

Expand All @@ -13,6 +13,11 @@ The things being connected are called nodes and the connections are called links
This example taken from [observable](https://observablehq.com/@d3/sankey/2?collection=@d3/d3-sankey). It may be rendered a little bit differently, though, in terms of size and colors.

```mermaid-example
---
config:
sankey:
showValues: false
---
sankey-beta
Agricultural 'waste',Bio-conversion,124.729
Expand Down

0 comments on commit c12deca

Please sign in to comment.