marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-21 00:09:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update n00b-gettingStarted.md

Browse Source
This commit is contained in:
Neil Cuzon
2020-11-15 03:19:28 -08:00
committed by GitHub
parent 6032e33290
commit 2b4ceda937
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/n00b-gettingStarted.md
View File

@@ -30,15 +30,17 @@ In the `Code` section one can write or edit raw mermaid code, and instantly `Pre
For some popular video tutorials on the live editor go to [Overview](/overview/n00b-overview.md).
![Flowchart](/img/n00b-liveEditor.png)
![Flowchart](./img/DiagramDefinition.png)
**Notes:**
You can also click "Copy Markdown" to copy the markdown code for the diagram, that can then be pasted directly into your documentation.
![Flowchart](/img/liveEditorOptions.png)
![Flowchart](./img/DownloadChoices.png)
The `Mermaid configuration` is for controlling mermaid behaviour. An easy introduction to mermaid configuration is found in the [Advanced usage](n00b-advanced.md) section. A complete configuration reference cataloguing default values is found on the [mermaidAPI](Setup.md) page.
The `Mermaid configuration` is for configuring the appearance and behavior of mermaid diagrams. An easy introduction to mermaid configuration is found in the [Advanced usage](./n00b-advanced.md) section. A complete configuration reference cataloguing default values is found on the [mermaidAPI](Setup.md) page.
![Flowchart](./img/Configuration.png)
## 2. Using mermaid plugins:
@@ -63,7 +65,7 @@ a. A reference for fetching the online mermaid renderer, which is written in Jav
b. The mermaid code for the diagram we want to create.
c. The `mermaid.initialize()` API call to start the rendering process.
c. The `mermaid.initialize()` call to start the rendering process.
## This is what needs to go into the html file (and all of them are important), for the mermaidAPI to render the diagrams: