mirrors
/
mermaid
mirror of https://github.com/mermaid-js/mermaid.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update n00b-gettingStarted.md

This commit is contained in:
Neil Cuzon 2021-05-01 02:26:41 -07:00 committed by GitHub
parent 5dc7c62cd4
commit 073c9445ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/n00b-gettingStarted.md
View File

@ -1,15 +1,16 @@
# A Mermaid User-Guide for Beginners
Mermaid has two halves, One half is concerned with Deployment and the is concerned with Configuration of values.
This section talks about the ways of deploying mermaid. The next section will talk about the other half, which is configuration of values that dictate how diagrams are rendered.
This section talks about the deployment of Mermaid. Learning the [Syntax](./n00b-syntaxReference.md) ahead of time would be helpful.
>Generally the live editor is enough for most general uses of mermaid.
>Generally the live editor is enough for most general uses of mermaid, and is a good place to test out your syntax.
**Absolute beginners are recommended to view the Video [Tutorials](./Tutorials.md) on the Live Editor, to gain a better understanding of mermaid.**
## Four ways of using mermaid:
1. Using the mermaid [Live Editor](https://mermaid-js.github.io/mermaid-live-editor/).
- Learning the [Syntax](./n00b-syntaxReference) would be helpful.
1. Using the mermaid [Live Editor](https://mermaid-js.github.io/mermaid-live-editor/).
2. Using [mermaid plugins](./integrations.md) with programs you are familiar with.
3. Calling the Mermaid Javascript API.
4. Deploying Mermaid as a dependency.
@ -37,6 +38,7 @@ You may choose any of the methods below, to save it
![Flowchart](./img/Configuration.png)
There are some Syntax,
## 2. Using Mermaid Plugins: