Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: add icon explanations #5681

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/syntax/block.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@

# Block Diagrams Documentation

## Icons

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

```mermaid-example
Expand Down
8 changes: 8 additions & 0 deletions docs/syntax/xyChart.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@

# XY Chart

## Icons

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.

> It's important to note that while the current implementation of mermaid-js includes these two chart types, the framework is designed to be dynamic and adaptable. Therefore, it has the capacity for expansion and the inclusion of additional chart types in the future. This means that users can expect an evolving suite of charting options within the XY chart module, catering to various data visualization needs as new chart types are introduced over time.
Expand Down
9 changes: 9 additions & 0 deletions packages/mermaid/src/docs/syntax/block.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ outline: 'deep' # shows all h3 headings in outline in Vitepress

# Block Diagrams Documentation

## Icons

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

```mermaid
Expand Down
9 changes: 9 additions & 0 deletions packages/mermaid/src/docs/syntax/xyChart.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# XY Chart

## Icons

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.

> It's important to note that while the current implementation of mermaid-js includes these two chart types, the framework is designed to be dynamic and adaptable. Therefore, it has the capacity for expansion and the inclusion of additional chart types in the future. This means that users can expect an evolving suite of charting options within the XY chart module, catering to various data visualization needs as new chart types are introduced over time.
Expand Down
Loading