GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-14 06:43:25 +08:00
Code Issues Projects Releases Wiki Activity

Updated noob-gettingStarted.md

Browse Source 
updated documentation for noob-gettingStarted.md. 
-added a new screenshot and edited directions for copying markdown code from live editor
-made some alterations with the instructions in effort to make it more n00b friendly.
-added link to Atom-mermaid plugin
This commit is contained in:
NeilCuzon 2020-02-22 23:20:50 -08:00 committed by GitHub
parent 553b964ab8
commit 9607c743a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/n00b-gettingStarted.md
View File

@ -1,4 +1,4 @@
# A basic User-Guide for Beginners
# A basic mermaid User-Guide for Beginners
Creating diagrams and charts, using mermaid code is simple.
@ -11,7 +11,7 @@ Most widely used web browsers, such as Firefox, Chrome and Safari, can render me
# For beginners, there are three relatively easy ways you can use mermaid:
1. Using the mermaid [live editor](https://mermaid-js.github.io/mermaid-live-editor/)
2. Using a mermaid plugin, such as that for Confluence or [Atom](https://atom.io/packages/atom-mermaid).
3. Calling mermaid with HTML, deployed in a friendly browser.
3. Calling mermaid renderer with HTML, deployed in a friendly browser.
# Following either of these examples, you can get started with creating your own diagrams using mermaid code.
@ -91,7 +91,6 @@ c. The `mermaid.initialize()` command to start the rendering process.
This is what needs to go into the html file:
# a. The reference to the mermaid renderer has to be contained in a `<script src>` tag like so:
```