From 9607c743a03a5bf4e6e7fa42d7451fc576e44352 Mon Sep 17 00:00:00 2001 From: NeilCuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Sat, 22 Feb 2020 23:20:50 -0800 Subject: [PATCH] Updated noob-gettingStarted.md 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 --- docs/n00b-gettingStarted.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/n00b-gettingStarted.md b/docs/n00b-gettingStarted.md index 3e76257e1..52c976d3d 100644 --- a/docs/n00b-gettingStarted.md +++ b/docs/n00b-gettingStarted.md @@ -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 `