diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e0a5ffde7a..738daab231 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,7 +2,7 @@
So you want to help? That's great!
-
+
Here are a few things to know to get you started on the right path.
@@ -76,7 +76,7 @@ This is important so that, if someone else does a change to the grammar that doe
### **Add e2e tests**
-This tests the rendering and visual apearance of the diagram. This ensures that the rendering of that feature in the e2e will be reviewed in the release process going forward. Less chance that it breaks!
+This tests the rendering and visual appearance of the diagram. This ensures that the rendering of that feature in the e2e will be reviewed in the release process going forward. Less chance that it breaks!
To start working with the e2e tests, run `yarn dev` to start the dev server, after that start cypress by running `cypress open` in the mermaid folder. (Make sure you have path to cypress in order, the binary is located in node_modules/.bin).
@@ -123,4 +123,4 @@ Don't get daunted if it is hard in the beginning. We have a great community with
[Join our slack community if you want closer contact!](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
-
+
diff --git a/README.md b/README.md
index e9645dcccb..0eb5340914 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,13 @@
English | [įŽäŊä¸æ](./README.zh-CN.md)
-
+
:trophy: **Mermaid was nominated and won the [JS Open Source Awards (2019)](https://osawards.com/javascript/2019) in the category "The most exciting use of technology"!!!**
**Thanks to all involved, people committing pull requests, people answering questions! đ**
-
+
## About
@@ -36,7 +36,7 @@ For a more detailed introduction to Mermaid and some of its more basic uses, loo
__The following are some examples of the diagrams, charts and graphs that can be made using Mermaid. Click here jump into the [text syntax](https://mermaid-js.github.io/mermaid/#/n00b-syntaxReference).__
-## Flowchart [docs - live editor]
+### Flowchart [docs - live editor]
```
flowchart LR
@@ -54,7 +54,7 @@ C -->|Two| E[Result 2]
```
-## Sequence diagram [docs - live editor]
+### Sequence diagram [docs - live editor]
```
sequenceDiagram
@@ -79,7 +79,7 @@ John->>Bob: How about you?
Bob-->>John: Jolly good!
```
-## Gantt chart [docs - live editor]
+### Gantt chart [docs - live editor]
```
gantt
@@ -102,7 +102,7 @@ gantt
Parallel 4 : des6, after des4, 1d
```
-## Class diagram [docs - live editor]
+### Class diagram [docs - live editor]
```
classDiagram
@@ -141,7 +141,7 @@ class Class10 {
}
```
-## State diagram [docs - live editor]
+### State diagram [docs - live editor]
```
stateDiagram-v2
[*] --> Still
@@ -176,9 +176,9 @@ pie
"Rats" : 15
```
-## Git graph [experimental - live editor]
+### Git graph [experimental - live editor]
-## User Journey diagram [docs - live editor]
+### User Journey diagram [docs - live editor]
```
journey
title My working day
@@ -202,7 +202,7 @@ pie
Sit down: 3: Me
```
-### Release
+## Release
For those who have the permission to do so:
diff --git a/docs/README.md b/docs/README.md
index 627a994bf9..07f9df29cc 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -7,14 +7,14 @@ It is a Javascript based diagramming and charting tool that renders Markdown-ins
>If you are familiar with Markdown you should have no problem learning [Mermaid's Syntax](./n00b-syntaxReference.md).
-
+
[](https://travis-ci.org/mermaid-js/mermaid) [](https://www.npmjs.com/package/mermaid) [](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
-
-[](https://mermaid-js.github.io/mermaid/landing/)
+
+[](https://mermaid-js.github.io/mermaid/landing/)
@@ -41,7 +41,7 @@ For a more detailed introduction to Mermaid and some of its more basic uses, loo
**Thanks to all involved, people committing pull requests, people answering questions and special thanks to Tyler Long who is helping me maintain the project đ**
-# Diagram Types
+## Diagram Types
### [Flowchart](./flowchart.md?id=flowcharts-basic-syntax)
@@ -161,7 +161,7 @@ journey
```
-# Installation
+## Installation
**In depth guides and examples can be found at [Getting Started](/n00b-gettingStarted) and [Usage](/usage).**
@@ -188,7 +188,7 @@ To Deploy Mermaid:
4. You can then add mermaid as a dev dependency using this command:
`yarn add --dev mermaid`
-## [Mermaid API](./Setup.md):
+### [Mermaid API](./Setup.md):
**To deploy mermaid without a bundler, one can insert a `script` tag with an absolute address and a `mermaidAPI` call into the HTML like so:**
@@ -201,7 +201,7 @@ To Deploy Mermaid:
**Examples can be found at** [Other examples](/examples)
-# Sibling projects
+## Sibling projects
- [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor)
- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli)
diff --git a/docs/Tutorials.md b/docs/Tutorials.md
index d7ae1cade2..40b5a307e9 100644
--- a/docs/Tutorials.md
+++ b/docs/Tutorials.md
@@ -71,4 +71,4 @@ graph LR;
**Output**
-
+
diff --git a/docs/developer-docs/configuration.md b/docs/developer-docs/configuration.md
index fde2077fc5..313dc8eae9 100644
--- a/docs/developer-docs/configuration.md
+++ b/docs/developer-docs/configuration.md
@@ -26,5 +26,3 @@ Initialize call is called **only once**. It is called by the site integrator in
## configApi.reset
This method resets the configuration for a diagram to the site configuration, the configuration provided by the site integrator. Before each rendering of a diagram reset is called in the very beginning of render.
-
-##