Merge pull request #1098 from mermaid-js/feature/1053_documentation-update

Feature/1053 documentation update

docs/_sidebar.md

@@ -14,8 +14,15 @@
   - [State Diagram](stateDiagram.md)
   - [Gantt](gantt.md)
   - [Pie Chart](pie.md)
+
 - Guide
 
   - [Development](development.md)
   - [mermaidAPI](mermaidAPI.md)
-  - [Changelog](CHANGELOG.md)
+  - [Changelog](CHANGELOG.md)
+
+- I'm a n00b
+  - [overview](n00b-overview.md)
+  - [Getting started - easier](n00b-gettingStarted.md)
+  - [Diagram syntax intro](n00b-syntaxReference.md)
+  - [Advanced usage](n00b-advanced.md)

docs/mermaidAPI.md

@@ -275,7 +275,7 @@ mermaidAPI.initialize({
 
 <pre>
 
-<script>
+&lt;script>
   var config = {
     theme:'default',
     logLevel:'fatal',
@@ -317,8 +317,7 @@ mermaidAPI.initialize({
     }
   };
   mermaid.initialize(config);
-</script>
-
+&lt;/script>
 </pre>
 
 [1]: https://github.com/knsv/mermaid/blob/master/docs/mermaidAPI.md#render

docs/n00b-advanced.md

@@ -0,0 +1,21 @@
+# Advanced n00b mermaid (Coming soon..)
+
+## splitting mermaid code from html
+A more condensed html code can be achieved by embedding the mermaid code in its own .js file, which is referenced like so:
+
+```
+stuff stuff
+  </div>
+  </body>
+</html>
+```
+The actual mermaid file could for example look like this:
+
+```
+mermaid content...
+```
+---
+
+## mermaid configuration options
+
+...

docs/n00b-gettingStarted.md

@@ -0,0 +1,154 @@
+# A more basic getting started
+
+Writing mermaid code is simple.
+
+But how is the code turned into a diagram in a web page? To do this we need a mermaid renderer.
+
+Thankfully the mermaid renderer is very accessible, in essence it is a javascript.
+
+The requirement is on the part of the web browser. Modern web browsers, such as Firefox, Chrome and Safari, can render mermaid. But Internet Explorer cannot. The web browser also needs access to the online mermaid renderer which it downloads from https://cdn.jsdelivr.net/npm/mermaid
+
+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 with converting your own mermaid code into web diagrams.
+
+## the mermaid live editor
+
+The quickest way to get started with mermaid is to visit [The mermaid live editor](https://mermaidjs.github.io/mermaid-live-editor).
+
+In the `Code` section one can write or edit raw mermaid code, and instantly `Preview` the rendered result.
+
+This is a great way to get started.
+
+It is also the easiest way to develop diagrams, the code of which can be pasted straight into documentation.
+
+![Flowchart](./img/n00b-liveEditor.png)
+
+The `Mermaid configuration` is for controlling mermaid behaviour. 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](mermaidAPI.md) page.
+
+
+## mermaid using plugins
+
+Thanks to the growing popularity of mermaid, many plugins already exist which incorporate a mermaid renderer.
+
+One example is the [Atlassian Confluence mermaid plugin](https://marketplace.atlassian.com/apps/1214124/mermaid-plugin-for-confluence?hosting=server&tab=overview)
+
+When the mermaid plugin is installed on a Confluence server, one can insert a mermaid object into any Confluence page.
+
+---
+
+- In a Confluence page, Add Other macros.
+
+![Flowchart](./img/n00b-Confluence1.png)
+
+---
+
+- Search for mermaid.
+
+![Flowchart](./img/n00b-Confluence2.png)
+
+---
+
+- The mermaid object appears. Paste your mermaid code into it.
+
+![Flowchart](./img/n00b-Confluence3.png)
+
+---
+
+- Save the page and the diagram appears.
+
+![Flowchart](./img/n00b-Confluence4.png)
+
+---
+
+## mermaid using any web server (or just a browser)
+
+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, apart from a normal file of html to be reached by a web browser (such as Firefox, Chrome, Safari, but not Internet Explorer). So if you want to really simplify things when testing this out, don't use a web server at all but just create the file locally and drag it into your browser window. It is the browser which does all the work of rendering mermaid!
+
+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, the renderer is just a javascript.
+2. the mermaid code we want to diagram.
+3. the `mermaid.initialize()` command to start the rendering process
+
+All this is done in the html `<body>` section of the web page.
+
+This is what needs to go into the html file:
+
+
+
+1. The reference to the mermaid renderer is done in a `<script src>` tag like so:
+
+```
+<body>
+  <script src="https://cdn.jsdelivr.net/npm/mermaid@8.4.0/dist/mermaid.min.js"></script>
+</body>
+```
+
+2. The embedded mermaid code is similarly placed in a `<div>` tag:
+
+```
+<body>
+  Here is a mermaid diagram:
+  <div class="mermaid">
+    graph TD
+    A[Client] --> B[Load Balancer]
+    B --> C[Server01]
+    B --> D[Server02]
+  </div>
+</body>
+```
+
+3. When initializing mermaid using `mermaid.initialize()`, mermaid takes all the `<div class="mermaid">` tags it can find in the html body and starts to render them one by one. This is done like so:
+
+```
+<body>
+  <script>mermaid.initialize({startOnLoad:true});</script>
+</body>
+```
+
+*Finally*
+4. Putting the three steps together is as simple as:
+```
+<html>
+  <body>
+    <script src="https://cdn.jsdelivr.net/npm/mermaid@8.4.0/dist/mermaid.min.js"></script>
+    <script>mermaid.initialize({startOnLoad:true});</script>
+
+    Here is one mermaid diagram:
+    <div class="mermaid">
+      graph TD
+      A[Client] --> B[Load Balancer]
+      B --> C[Server1]
+      B --> D[Server2]
+    </div>
+
+    And here is another:
+    <div class="mermaid">
+      graph TD
+      A[Client] -->|tcp_123| B(Load Balancer)
+      B -->|tcp_456| C[Server1]
+      B -->|tcp_456| D[Server2]
+    </div>
+  </body>
+</html>
+```
+Save this to a html file and fetch it with a browser from the web server (or just drag it into your web browser window) and voila!
+
+---
+
+**Three additional comments from Knut Sveidqvist, creator of mermaid:**
+- In early versions of mermaid, the `<script src>` tag was invoked in the `<head>` part of the web page. Nowdays we can place it directly in `<body>` as seen above. However, older parts of the documentation frequently reflects the previous way which still works.
+  
+- We initialize the mermaid rendering with `mermaid.initialize()` directly in the html code. In principle this could be done through placing `mermaid.initialize()` inside of `mermaid.min.js`. We would then eliminate the need for this explicit line in the html. However, there are use cases where we do want to separate the two steps. Sometimes we want full control over when we start looking for `<div>`tags inside the web page with `mermaid.initialize()`, for example when we think that all `<div>` tags may not have been loaded by the time `mermaid.min.js` runs.
+
+- In the example above, `mermaid.min.js` is called using an absolute path. Even worse, the example includes the mermaid version number which of course will change as time goes by. However, the example makes it easy to understand what is going on - even though it is perhaps doomed in a way we do not want in a production environment. When going from testing mermaid out to getting serious with it, I would suggest one of the following approaches for calling `mermaid.min.js`:
+  
+  1. If you do not enter a specific version, you automatically get the latest one.
+  2. If you really need a specific version, hard code it (this is rare but it happens).
+  3. If you need to know the current mermaid version, replace a mermaid code block with the word `info` and the version will be returned like [this](https://mermaid-js.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiaW5mb1xuXG4iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ==)
+   

docs/n00b-overview.md

@@ -0,0 +1,27 @@
+# Overview for n00bs
+
+As a sysadmin I frequently have to document things, including drawing stuff.
+
+Using mermaid, I can type this as a comment in a script:
+
+```
+graph TD
+A[Client] --> B[Load Balancer]
+B --> C[Server01]
+B --> D[Server02]
+```
+
+And end up with this in the documentation:
+
+![Flowchart](./img/n00b-firstFlow.png)
+
+Most of the stuff I need to visualize can be scripted in a similar way, with a varitety of different symbols and chart types available. Since the diagram source is text based, it can be part of production scripts (and other pieces of code). So less time needs be spent on documenting as a separate task.
+
+Comparing with Visio and similar applications, mermaid is a really fast way to create good visualizations. This is especially apparent when editing a complex visualisation, this could take me hours in a desktop application but takes minutes (or even less if generation has been scripted) with mermaid.
+
+With mermaid I can spend a fraction of the time I normally would spend, and instead automate the diagram generation and end up saving even more time. I love it!
+
+
+However, a lot of the mermaid documentation is geared to professional frontend developers, presuming a skill set which I simply do not have.
+
+I needed a really basic instruction. And here it is.

docs/n00b-syntaxReference.md

@@ -0,0 +1,11 @@
+## Diagram syntax reference
+
+Having already [gotten started](n00b-gettingStarted.md), existing diagram syntax documentation was easy enough to follow even for a n00b like me..
+
+- [Flowchart](flowchart.md)
+- [Sequence diagram](sequenceDiagram.md)
+- [Class Diagram](classDiagram.md)
+- [State Diagram](stateDiagram.md)
+- [Gantt](gantt.md)
+- [Pie Chart](pie.md)
+

src/mermaidAPI.js

@@ -686,7 +686,7 @@ export default mermaidAPI;
  * ## mermaidAPI configuration defaults
  * <pre>
  *
- * <script>
+ * &lt;script>
  *   var config = {
  *     theme:'default',
  *     logLevel:'fatal',
@@ -728,6 +728,6 @@ export default mermaidAPI;
  *     }
  *   };
  *   mermaid.initialize(config);
- * </script>
+ * &lt;/script>
  *</pre>
  */