chore: Prettier

This commit is contained in:
Sidharth Vinod
2024-03-23 11:39:02 +05:30
parent 3278899787
commit 16f1dccd22
76 changed files with 508 additions and 366 deletions

View File

@@ -8,9 +8,9 @@
## Mermaid is composed of three parts
1. Deployment
2. Syntax
3. Configuration
1. Deployment
2. Syntax
3. Configuration
This section talks about the different ways to **deploy** Mermaid.
@@ -21,11 +21,11 @@ If you are a beginner:
## Ways to use Mermaid
1. [Using the Mermaid Live Editor](getting-started.md#_1-using-the-mermaid-live-editor)
2. [Using the Mermaid Chart Editor](getting-started.md#_2-using-the-mermaid-chart-editor)
3. [Using Mermaid Plugins and Integrations](getting-started.md#_3-using-mermaid-plugins)
4. [Calling the Mermaid JavaScript API](getting-started.md#_4-calling-the-mermaid-javascript-api)
5. [Adding Mermaid as a dependency](getting-started.md#_5-adding-mermaid-as-a-dependency)
1. [Using the Mermaid Live Editor](getting-started.md#_1-using-the-mermaid-live-editor)
2. [Using the Mermaid Chart Editor](getting-started.md#_2-using-the-mermaid-chart-editor)
3. [Using Mermaid Plugins and Integrations](getting-started.md#_3-using-mermaid-plugins)
4. [Calling the Mermaid JavaScript API](getting-started.md#_4-calling-the-mermaid-javascript-api)
5. [Adding Mermaid as a dependency](getting-started.md#_5-adding-mermaid-as-a-dependency)
To learn more, visit the [Usage](../config/usage.md) page.
@@ -301,22 +301,22 @@ In this example, `mermaid.js` is referenced in `src` as a separate JavaScript fi
Below are the steps for adding Mermaid as a dependency:
1. Install `node v16`
1. Install `node v16`
> **Note**
> To learn more about downloading and installing `Node.js` and `npm`, visit the [npm Docs website](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
1. Install `yarn` using `npm` with this command:
1. Install `yarn` using `npm` with this command:
`npm install -g yarn`
`npm install -g yarn`
2. After yarn installs, enter this command:
2. After yarn installs, enter this command:
`yarn add mermaid`
`yarn add mermaid`
3. To add Mermaid as a dev dependency, enter this command:
3. To add Mermaid as a dev dependency, enter this command:
`yarn add --dev mermaid`
`yarn add --dev mermaid`
## Closing note

View File

@@ -311,7 +311,9 @@ xychart-beta
### CDN
https://cdn.jsdelivr.net/npm/mermaid@<version>/dist/
```
https://cdn.jsdelivr.net/npm/mermaid@<version>/dist/
```
To select a version:
@@ -323,11 +325,11 @@ Latest Version: <https://cdn.jsdelivr.net/npm/mermaid@11>
To Deploy Mermaid:
1. You will need to install node v16, which would have npm
2. Install mermaid
- NPM: `npm i mermaid`
- Yarn: `yarn add mermaid`
- Pnpm: `pnpm add mermaid`
1. You will need to install node v16, which would have npm
2. Install mermaid
- NPM: `npm i mermaid`
- Yarn: `yarn add mermaid`
- Pnpm: `pnpm add mermaid`
### [Mermaid API](../config/setup/README.md):

View File

@@ -51,7 +51,7 @@ One should **beware the use of some words or symbols** that can break diagrams.
| Diagram Breakers | Reason | Solution |
| ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- | ------------------------------------------------- |
| **Comments** | | |
| [` %%{``}%% `](https://github.com/mermaid-js/mermaid/issues/1968) | Similar to [Directives](../config/directives.md) confuses the renderer. | In comments using `%%`, avoid using "{}". |
| [`%%{``}%%`](https://github.com/mermaid-js/mermaid/issues/1968) | Similar to [Directives](../config/directives.md) confuses the renderer. | In comments using `%%`, avoid using "{}". |
| **Flow-Charts** | | |
| 'end' | The word "End" can cause Flowcharts and Sequence diagrams to break | Wrap them in quotation marks to prevent breakage. |
| [Nodes inside Nodes](../syntax/flowchart.md?id=special-characters-that-break-syntax) | Mermaid gets confused with nested shapes | wrap them in quotation marks to prevent breaking |