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

Merge branch 'develop' into pr/RohanHandore/4340

Browse Source 
* develop:
  Update flowchart.md (#4798)
  Update flowchart.md (#4792)
  chore: Fix warning formatting
  docs: Disable showValues in sankey example
This commit is contained in:
Sidharth Vinod
2023-09-06 23:22:45 +05:30
parent 7d2b39f69f 19f0308142
commit f0d388851b
4 changed files with 26 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/syntax/flowchart.md
View File

@@ -860,8 +860,8 @@ flowchart LR
C-->D C-->D
click A callback "Tooltip for a callback" click A callback "Tooltip for a callback"
click B "https://www.github.com" "This is a tooltip for a link" click B "https://www.github.com" "This is a tooltip for a link"
click A call callback() "Tooltip for a callback" click C call callback() "Tooltip for a callback"
click B href "https://www.github.com" "This is a tooltip for a link" click D href "https://www.github.com" "This is a tooltip for a link"
``` ```
```mermaid ```mermaid
@@ -871,8 +871,8 @@ flowchart LR
C-->D C-->D
click A callback "Tooltip for a callback" click A callback "Tooltip for a callback"
click B "https://www.github.com" "This is a tooltip for a link" click B "https://www.github.com" "This is a tooltip for a link"
click A call callback() "Tooltip for a callback" click C call callback() "Tooltip for a callback"
click B href "https://www.github.com" "This is a tooltip for a link" 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. > **Success** The tooltip functionality and the ability to link to urls are available from version 0.5.2.

15
docs/syntax/sankey.md
View File

@@ -8,9 +8,8 @@
> A sankey diagram is a visualization used to depict a flow from one set of values to another. > 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. > 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. The things being connected are called nodes and the connections are called links.
@@ -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. 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 ```mermaid-example
---
config:
sankey:
showValues: false
---
sankey-beta sankey-beta
Agricultural 'waste',Bio-conversion,124.729 Agricultural 'waste',Bio-conversion,124.729
@@ -92,6 +96,11 @@ Wind,Electricity grid,289.366
``` ```
```mermaid ```mermaid
---
config:
sankey:
showValues: false
---
sankey-beta sankey-beta
Agricultural 'waste',Bio-conversion,124.729 Agricultural 'waste',Bio-conversion,124.729

6
packages/mermaid/src/docs/syntax/flowchart.md
View File

@@ -554,13 +554,13 @@ flowchart LR
C-->D C-->D
click A callback "Tooltip for a callback" click A callback "Tooltip for a callback"
click B "https://www.github.com" "This is a tooltip for a link" click B "https://www.github.com" "This is a tooltip for a link"
click A call callback() "Tooltip for a callback" click C call callback() "Tooltip for a callback"
click B href "https://www.github.com" "This is a tooltip for a link" 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. > **Success** The tooltip functionality and the ability to link to urls are available from version 0.5.2.
?> Due to limitations with how Docsify handles JavaScript callback functions, an alternate working demo for the above code can be viewed at [this jsfiddle](https://jsfiddle.net/s37cjoau/3/). ?> Due to limitations with how Docsify handles JavaScript callback functions, an alternate working demo for the above code can be viewed at [this jsfiddle](https://jsfiddle.net/Ogglas/2o73vdez/7).
Links are opened in the same browser tab/window by default. It is possible to change this by adding a link target to the click definition (`_self`, `_blank`, `_parent` and `_top` are supported): Links are opened in the same browser tab/window by default. It is possible to change this by adding a link target to the click definition (`_self`, `_blank`, `_parent` and `_top` are supported):

9
packages/mermaid/src/docs/syntax/sankey.md
View File

@@ -2,9 +2,9 @@
> A sankey diagram is a visualization used to depict a flow from one set of values to another. > 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. 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. The things being connected are called nodes and the connections are called links.
@@ -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. 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 ```mermaid-example
---
config:
sankey:
showValues: false
---
sankey-beta sankey-beta
Agricultural 'waste',Bio-conversion,124.729 Agricultural 'waste',Bio-conversion,124.729