Merge branch 'master' into develop

* master: Update flowchart.md (#4798) chore: Fix warning formatting docs: Disable showValues in sankey example
mermaid-js · Sep 6, 2023 · c12deca · c12deca
2 parents 773abbe + 2eb9afa
commit c12deca
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 11 deletions.
diff --git a/docs/syntax/flowchart.md b/docs/syntax/flowchart.md
@@ -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
@@ -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.

diff --git a/docs/syntax/sankey.md b/docs/syntax/sankey.md
@@ -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.
 
@@ -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
@@ -92,6 +96,11 @@ Wind,Electricity grid,289.366
 ```
 
 ```mermaid
+---
+config:
+  sankey:
+    showValues: false
+---
 sankey-beta
 
 Agricultural 'waste',Bio-conversion,124.729

diff --git a/packages/mermaid/src/docs/syntax/flowchart.md b/packages/mermaid/src/docs/syntax/flowchart.md
@@ -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.

diff --git a/packages/mermaid/src/docs/syntax/sankey.md b/packages/mermaid/src/docs/syntax/sankey.md
@@ -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.
 
@@ -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