4M
z4lW7%l9IqY(z7pV(?I@@8=KPFO82)O{VDI18-*d-k$YmI^XiuPs_LuFw<^ZcD}yP5
c*NrbeloN*74g`U%%F6r~k%+>C^#XapzmV0H-2eap
diff --git a/docs/integrations.md b/docs/integrations.md
index f1ce8757b..b8a514f82 100644
--- a/docs/integrations.md
+++ b/docs/integrations.md
@@ -1,7 +1,5 @@
# Integrations
-**Edit this Page** [![N|Solid](img/GitHub-Mark-32px.png)](https://github.com/mermaid-js/mermaid/blob/develop/docs/integrations.md)
-
The following list is a compilation of different integrations and plugins that allow the rendering of mermaid definitions
They also serve as proof of concept, for the variety of things that can be built with mermaid.
diff --git a/docs/n00b-gettingStarted.md b/docs/n00b-gettingStarted.md
index a5db535f0..f200b07d2 100644
--- a/docs/n00b-gettingStarted.md
+++ b/docs/n00b-gettingStarted.md
@@ -1,7 +1,5 @@
# A basic mermaid User-Guide for Beginners
-**Edit this Page** [![N|Solid](img/GitHub-Mark-32px.png)](https://github.com/mermaid-js/mermaid/blob/develop/docs/n00b-gettingStarted.md)
-
Creating diagrams and charts using mermaid code is simple.
The code is turned into a diagram in the web page with the use of a mermaid renderer.
@@ -75,7 +73,7 @@ When the mermaid plugin is installed on a Confluence server, one can insert a me
![Flowchart](../img/n00b-Confluence4.png)
---
-## The following are two ways of hosting mermaid on a webpage.
+## The following are two ways of hosting mermaid on a webpage.
**This is covered in greater detail in the [Usage section](usage.md)**
## 3. Using the Mermaid API: The quick and dirty way of deploying mermaid
@@ -199,7 +197,7 @@ This method is similar to 3, if only a little more involved. The difference may
8. Add the graph and diagram definitions as you would in number 3.
a. be mindful of the `div` tags.
-9. Save, load/edit your HTML file to your liking.
+9. Save, load/edit your HTML file to your liking.
**Note** placing the HTML file on the same folder the `mermaid` file you've downloaded is a good practice and allows you to shorten the address on the `src` section.
diff --git a/docs/n00b-overview.md b/docs/n00b-overview.md
index 18271ed8e..785599e13 100644
--- a/docs/n00b-overview.md
+++ b/docs/n00b-overview.md
@@ -1,9 +1,6 @@
# Overview for Beginners
-
-**Edit this Page** [![N|Solid](img/GitHub-Mark-32px.png)](https://github.com/mermaid-js/mermaid/blob/develop/docs/n00b-overview.md)
-
-## Explaining with a Diagram
+## Explaining with a Diagram
A picture is worth a thousand words, a good diagram would be worth more. There is no disputing that they are indeed very useful. Yet very few people use them, even fewer still do so for documentation. Mainly because it takes too much time that could be used for more important functions.
@@ -18,7 +15,7 @@ In an environment of constantly changing information , diagrams/charts are both
Doc-Rot is quite quick on diagrams makes, after a change is made, it quite hard to rationalize taking hours in a desktop application, to produce a diagram that you would need to recreate again the following week in order to account for updates and changes in the app you are documenting. Yet that is often the reality for diagrams and charts and the people who make them.
-mermaid seeks to change that. mermaid is a javascript based tool that utilizes a markdown inspired syntax to generate documentation, which is actually quicker, less complicated and more convenient than most traditional diagramming software. This is a relatively straightforward solution to a major hurdle in software teams.
+mermaid seeks to change that. mermaid is a javascript based tool that utilizes a markdown inspired syntax to generate documentation, which is actually quicker, less complicated and more convenient than most traditional diagramming software. This is a relatively straightforward solution to a major hurdle in software teams.
# :blue_book: Definition of Terms/ Dictionary
diff --git a/docs/n00b-syntaxReference.md b/docs/n00b-syntaxReference.md
index 15ff14207..09f6b7612 100644
--- a/docs/n00b-syntaxReference.md
+++ b/docs/n00b-syntaxReference.md
@@ -1,8 +1,5 @@
## Diagram syntax
-
-**Edit this Page** [![N|Solid](img/GitHub-Mark-32px.png)](https://github.com/mermaid-js/mermaid/blob/develop/docs/n00b-syntaxReference.md)
-
If you are new to mermaid, read the [Getting Started](../getting-started/n00b-gettingStarted.md) and [Overview](../overview/n00b-overview.md) sections, to learn the basics of mermaid.
Video Tutorials can be found at the bottom of the Overview Section.
@@ -10,7 +7,7 @@ This section is a list of diagram types supported by mermaid. Below is a list of
They also detail how diagrams can be defined, or described in the manner with which the diagram is to be rendered by the renderer.
-### The benefits of text based diagramming are its speed and modifiability. mermaid allows for easy maintenance and modification of diagrams. This means your diagrams will always be up to date and closely follow your code and improve your documentation.
+### The benefits of text based diagramming are its speed and modifiability. mermaid allows for easy maintenance and modification of diagrams. This means your diagrams will always be up to date and closely follow your code and improve your documentation.
## mermaid tag:
These Diagram Definitions can be entered within a \ tag.
diff --git a/docs/newDiagram.md b/docs/newDiagram.md
index ddd8670d0..b1b5b8036 100644
--- a/docs/newDiagram.md
+++ b/docs/newDiagram.md
@@ -1,8 +1,5 @@
# Adding a New Diagram/Chart đź“Š
-
-**Edit this Page** [![N|Solid](img/GitHub-Mark-32px.png)](https://github.com/mermaid-js/mermaid/blob/develop/docs/newDiagram.md)
-
### Step 1: Grammar & Parsing
diff --git a/docs/pie.md b/docs/pie.md
index e2c1b31b7..7e49ca1f2 100644
--- a/docs/pie.md
+++ b/docs/pie.md
@@ -1,7 +1,5 @@
# Pie chart diagrams
-**Edit this Page** [![N|Solid](img/GitHub-Mark-32px.png)](https://github.com/mermaid-js/mermaid/blob/develop/docs/pie.md)
-
> A pie chart (or a circle chart) is a circular statistical graphic, which is divided into slices to illustrate numerical proportion. In a pie chart, the arc length of each slice (and consequently its central angle and area), is proportional to the quantity it represents. While it is named for its resemblance to a pie which has been sliced, there are variations on the way it can be presented. The earliest known pie chart is generally credited to William Playfair's Statistical Breviary of 1801
-Wikipedia
@@ -31,11 +29,11 @@ Drawing a pie chart is really simple in mermaid.
- Followed by `positive numeric value` (supported upto two decimal places)
[pie]
- [title] [titlevalue] (OPTIONAL)
- "[datakey1]" : [dataValue1]
- "[datakey2]" : [dataValue2]
- "[datakey3]" : [dataValue3]
- .
+ [title] [titlevalue] (OPTIONAL)
+ "[datakey1]" : [dataValue1]
+ "[datakey2]" : [dataValue2]
+ "[datakey3]" : [dataValue3]
+ .
.
## Example
diff --git a/docs/stateDiagram.md b/docs/stateDiagram.md
index de965bc57..5bec42408 100644
--- a/docs/stateDiagram.md
+++ b/docs/stateDiagram.md
@@ -1,7 +1,5 @@
# State diagrams
-**Edit this Page** [![N|Solid](img/GitHub-Mark-32px.png)](https://github.com/mermaid-js/mermaid/blob/develop/docs/stateDiagram.md)
-
> "A state diagram is a type of diagram used in computer science and related fields to describe the behavior of systems. State diagrams require that the system described is composed of a finite number of states; sometimes, this is indeed the case, while at other times this is a reasonable abstraction." Wikipedia
Mermaid can render state diagrams. The syntax tries to be compliant with the syntax used in plantUml as this will make it easier for users to share diagrams between mermaid and plantUml.
diff --git a/docs/usage.md b/docs/usage.md
index c9384e657..03e9d1ad1 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -1,7 +1,5 @@
# Usage
-**Edit this Page** [![N|Solid](img/GitHub-Mark-32px.png)](https://github.com/mermaid-js/mermaid/blob/develop/docs/usage.md)
-
mermaid is a javascript tool that makes use of a markdown based syntax to render customizable diagrams and charts, for greater speed and ease.
mermaid was made to help Documentation catch up with Development, in quickly changing projects.
diff --git a/docs/user-journey.md b/docs/user-journey.md
index 9546bde88..4e68f87bd 100644
--- a/docs/user-journey.md
+++ b/docs/user-journey.md
@@ -1,8 +1,5 @@
# User Journey Diagram
-
-**Edit this Page** [![N|Solid](img/GitHub-Mark-32px.png)](https://github.com/mermaid-js/mermaid/blob/develop/docs/user-journey.md)
-
> User journeys describe at a high level of detail exactly what steps different users take to complete a specific task within a system, application or website. This technique shows the current (as-is) user workflow, and reveals areas of improvement for the to-be workflow. (Wikipedia)
Mermaid can render user journey diagrams: