From 8666f4efbff5098bde646f171091414c4a91bbd7 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 16 Apr 2021 23:41:27 -0700 Subject: [PATCH] Update n00b-gettingStarted.md --- docs/n00b-gettingStarted.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/n00b-gettingStarted.md b/docs/n00b-gettingStarted.md index 9161f1a82..18e16a545 100644 --- a/docs/n00b-gettingStarted.md +++ b/docs/n00b-gettingStarted.md @@ -3,10 +3,10 @@ Creating diagrams and charts using mermaid code is simple. >The live editor is enough for most general uses of mermaid -## Absolute beginners are recommended to view the Video [Tutorials](./Tutorials.md) on the Live Editor, to gain a better understanding of mermaid. +**Absolute beginners are recommended to view the Video [Tutorials](./Tutorials.md) on the Live Editor, to gain a better understanding of mermaid.** -## For beginners, there are Four ways you can use 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. 2. Using [mermaid plugins](./integrations.md) with programs you are familiar with. @@ -17,7 +17,7 @@ Creating diagrams and charts using mermaid code is simple. >More in depth information can be found on [Usage](./usage.md). -## 1. Using [The mermaid live editor](https://mermaidjs.github.io/mermaid-live-editor). +## 1. Using [The Live Editor](https://mermaidjs.github.io/mermaid-live-editor). ![Flowchart](./img/Live-Editor-Usage.png) @@ -39,13 +39,13 @@ Downloading the image is recommended. ![Flowchart](./img/Configuration.png) -## 2. Using mermaid plugins: +## 2. Using Mermaid Plugins: Using plug-ins you can generate mermaid diagrams from within popular applications, the same way that you would use the Live Editor. Here's a list of [Mermaid Plugins](./integrations.md). **This is covered in greater detail in the [Usage section](usage.md)** -## 3. Deploying mermaid with Inline JavaScript +## 3. Mermaid with Inline JavaScript This method can be used with any common web server. Apache, IIS, nginx, node express [...], you pick your favourite. @@ -64,9 +64,9 @@ b. The mermaid code for the diagram we want to create. c. The `mermaid.initialize()` call to start the rendering process. -## Three requirements for the mermaidAPI to render a diagram: +## Requirements for mermaidAPI to render a diagram: -### a. A reference to the external CDN in a `