diff --git a/docs/img/n00b-liveEditor.png b/docs/img/n00b-liveEditor.png index aaab33b6d..071a44fca 100644 Binary files a/docs/img/n00b-liveEditor.png and b/docs/img/n00b-liveEditor.png differ diff --git a/docs/n00b-gettingStarted.md b/docs/n00b-gettingStarted.md index 02d6be4f3..de169ef81 100644 --- a/docs/n00b-gettingStarted.md +++ b/docs/n00b-gettingStarted.md @@ -2,11 +2,16 @@ Writing mermaid code is simple. -But how is it turned into a diagram in a web page? To do this We need a mermaid renderer. +But how is it turned into a diagram in a web page? To do this we need a mermaid renderer. -Thankfully the mermaid renderer is very accessible. The requirement is on the part of the web browser (modern web browsers such as Firefox, Chrome, Safari work, but Internet Explorer does not). The web browser also needs to be able to access the online mermaid renderer at cdn.jsdelivr.net/npm/ +Thankfully the mermaid renderer is very accessible. -Here is one example using an online mermaid editor, one example using a mermaid plugin and one example using a generic web server. +The requirement is on the part of the web browser. Modern web browsers work, such as Firefox, Chrome, Safari. But Internet Explorer does not. The web browser also needs to be able to access the online mermaid renderer at cdn.jsdelivr.net/npm/ + +For an easy introduction, here follows three practical examples using: +1. an online mermaid editor +2. a mermaid plugin +3. a generic web server of your choosing Following either of these examples, you can get started converting your own mermaid code into web diagrams. @@ -24,7 +29,7 @@ It is also the easiest way to develop diagrams, the code of which can be pasted The `Mermaid configuration` is for controlling the behaviour of mermaid. -An easy introduction is found in the [n00b Advanced section] and a complete configuration reference is found [here]. +An easy introduction to mermaid configuration is found in the [n00b Advanced section]. A complete configuration reference is found [here]. ## mermaid using plugins @@ -49,13 +54,13 @@ When the mermaid plugin is installed on a Confluence server, one can insert a me --- -- The mermaid object appears. Paste your mermaid code in it. +- The mermaid object appears. Paste your mermaid code into it. ![Flowchart](./img/n00b-Confluence3.png) --- -- Save the page. +- Save the page and the diagram appears. ![Flowchart](./img/n00b-Confluence4.png) @@ -63,20 +68,20 @@ When the mermaid plugin is installed on a Confluence server, one can insert a me ## mermaid using any web server -This example can be used with any web server: Apache, IIS, nginx, node express [...] +This example can be used with any common web server. Apache, IIS, nginx, node express [...], you pick your favourite. -We do not need to install anything on the server, to have it serve a mermaid diagram to a web browser (such as Firefox, Chrome, Safari, but not Internet Explorer). +We do not need to install anything on the server, apart from a normal file of html which can be reached by a web browser (such as Firefox, Chrome, Safari, but not Internet Explorer). -Instead, we need to give the web browser three instructions inside the html code it retrieves: -1. a reference for fetching the online mermaid renderer, which in essence is a javascript. +Through the html file, we give the web browser three instructions inside the html code it retrieves: +1. a reference for fetching the online mermaid renderer, in essence a javascript. 2. the mermaid code we want to diagram. -3. the initialize mermaid command. +3. the `mermaid.initialize()` command to start the rendering process All this is done in the html `` section of the web page. -The reference to the mermaid renderer is done in a ` - - Here we trigger the mermaid renderer, upon which it starts looking for mermaid
tags: Here is one mermaid diagram: @@ -143,9 +146,9 @@ Voila! Three additional comments from Knut, the creator of mermaid: - In early versions of mermaid, the `