From f6cd4547abcb8a58dba2ca02f010a5f32477a9c3 Mon Sep 17 00:00:00 2001 From: anugs <36812514+anugs@users.noreply.github.com> Date: Wed, 29 Sep 2021 22:18:46 +0530 Subject: [PATCH] Update n00b-gettingStarted.md --- docs/n00b-gettingStarted.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/n00b-gettingStarted.md b/docs/n00b-gettingStarted.md index 84ddabeb6..cec42356a 100644 --- a/docs/n00b-gettingStarted.md +++ b/docs/n00b-gettingStarted.md @@ -1,12 +1,12 @@ # A Mermaid User-Guide for Beginners -Mermaid is composed of three parts, Deployment, Syntax and Configuration. +Mermaid is composed of three parts: Deployment, Syntax and Configuration. -This section talks about the different ways to deploy Mermaid. Learning the [Syntax](./n00b-syntaxReference.md) ahead of time would be more helpful to the beginner. +This section talks about the different ways to deploy Mermaid. Learning the [Syntax](./n00b-syntaxReference.md) would be of great help to the beginner. > Generally the live editor is enough for most general uses of mermaid, and is a good place to start learning. -**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 advised to view the Video [Tutorials](./Tutorials.md) on the Live Editor, to gain a better understanding of mermaid.** ## Four ways of using mermaid: @@ -17,7 +17,7 @@ This section talks about the different ways to deploy Mermaid. Learning the [Syn **Note: It is our recommendation that you review all approaches, and choose the one that is best for your project.** -> More in depth information can be found on [Usage](./usage.md). +> More in depth information can be found at [Usage](./usage.md). ## 1. Using [The Live Editor](https://mermaid-js.github.io/mermaid-live-editor/edit). @@ -25,15 +25,15 @@ This section talks about the different ways to deploy Mermaid. Learning the [Syn In the `Code` section one can write or edit raw mermaid code, and instantly `Preview` the rendered result on the panel beside it. -The `Configuration` Section is for changing 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. +The `Configuration` Section is for changing 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 cataloging the default values can be found on the [mermaidAPI](Setup.md) page. ![Code,Config and Preview](./img/Code-Preview-Config.png) ### Editing History -Your code will be autosaved every minute into the Timeline tab of History, having the most recent 30 items. +Your code will be autosaved every minute into the Timeline tab of History which shows the most recent 30 items. -You can also manually save code by clicking the Save icon in History section which can be accessed in the Saved tab. This is stored only in the browser storage. +You can manually save code by clicking the Save icon in the History section. It can also be accessed in the Saved tab. This is stored in the browser storage only. ### Saving a Diagram: @@ -57,27 +57,27 @@ and to View, https://mermaid-js.github.io/mermaid-live-editor/view?gist=https:// ## 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). +You can generate mermaid diagrams from within popular applications using plug-ins. It can be done in the same way, 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. Calling the Javascript API -This method can be used with any common web server. Apache, IIS, nginx, node express, you are free to choose. +This method can be used with any common web server like Apache, IIS, nginx, node express. -You will also need a text editting tool like Notepad++, to generate an html file. It is then deployed by a web browser (such as Firefox, Chrome, Safari, but not Internet Explorer). +You will also need a text editing tool like Notepad++ to generate a .html file. It is then deployed by a web browser (such as Firefox, Chrome, Safari, but not Internet Explorer). -The API works by pulling rendering instructions from a source from `mermaid.js` to render diagrams in the page. +The API works by pulling rendering instructions from the source `mermaid.js` in order to render diagrams on the page. ### Requirements for the Mermaid API. -When writing the html file, we give the web browser three instructions inside the html code: +When writing the .html file, we give three instructions inside the html code to the web browser: a. A reference for fetching the online mermaid renderer, through the `mermaid.js` or `mermaid.min.js`. b. The mermaid code for the diagram we want to create. -c. The `mermaid.initialize()` call, which can dictate the appreance of diagrams and also start the rendering process . +c. The `mermaid.initialize()` call, which dictates the appearance of diagrams and also starts the rendering process . **a. A reference to the external CDN in a `