Added icon explanations in documentation

mermaid-js · Aug 1, 2024 · 145e615 · 145e615
1 parent a6933d9
commit 145e615
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 12 deletions.
diff --git a/docs/syntax/block.md b/docs/syntax/block.md
@@ -6,10 +6,13 @@
 
 # Block Diagrams Documentation
 
-**Icons:**
+## Icons
 
-- 🔥: Indicates newly added diagrams.
-- `-beta`: Marks diagrams with experimental syntax that might change over time.
+Here is a brief explanation of the icons used in the documentation:
+
+> **Note**
+> 🔥: Indicates newly added diagrams.<br>
+> -beta: Marks diagrams with experimental syntax that might change over time.
 
 ## Introduction to Block Diagrams
 

diff --git a/docs/syntax/xyChart.md b/docs/syntax/xyChart.md
@@ -6,10 +6,13 @@
 
 # XY Chart
 
-**Icons:**
+## Icons
 
-- 🔥: Indicates newly added diagrams.
-- `-beta`: Marks diagrams with experimental syntax that might change over time.
+Here is a brief explanation of the icons used in the documentation:
+
+> **Note**
+> 🔥: Indicates newly added diagrams.<br>
+> -beta: Marks diagrams with experimental syntax that might change over time.
 
 > In the context of mermaid-js, the XY chart is a comprehensive charting module that encompasses various types of charts that utilize both x-axis and y-axis for data representation. Presently, it includes two fundamental chart types: the bar chart and the line chart. These charts are designed to visually display and analyze data that involve two numerical variables.
 

diff --git a/packages/mermaid/src/docs/syntax/block.md b/packages/mermaid/src/docs/syntax/block.md
@@ -5,10 +5,14 @@ outline: 'deep' # shows all h3 headings in outline in Vitepress
 
 # Block Diagrams Documentation
 
-**Icons:**
+## Icons
 
-- 🔥: Indicates newly added diagrams.
-- `-beta`: Marks diagrams with experimental syntax that might change over time.
+Here is a brief explanation of the icons used in the documentation:
+
+```note
+🔥: Indicates newly added diagrams.<br>
+-beta: Marks diagrams with experimental syntax that might change over time.
+```
 
 ## Introduction to Block Diagrams
 

diff --git a/packages/mermaid/src/docs/syntax/xyChart.md b/packages/mermaid/src/docs/syntax/xyChart.md
@@ -1,9 +1,13 @@
 # XY Chart
 
-**Icons:**
+## Icons
 
-- 🔥: Indicates newly added diagrams.
-- `-beta`: Marks diagrams with experimental syntax that might change over time.
+Here is a brief explanation of the icons used in the documentation:
+
+```note
+🔥: Indicates newly added diagrams.<br>
+-beta: Marks diagrams with experimental syntax that might change over time.
+```
 
 > In the context of mermaid-js, the XY chart is a comprehensive charting module that encompasses various types of charts that utilize both x-axis and y-axis for data representation. Presently, it includes two fundamental chart types: the bar chart and the line chart. These charts are designed to visually display and analyze data that involve two numerical variables.