You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/config/advanced.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
>
3
3
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
4
4
>
5
-
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/n00b-advanced.md](../../packages/mermaid/src/docs/config/n00b-advanced.md).
5
+
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/advanced.md](../../packages/mermaid/src/docs/config/advanced.md).
Copy file name to clipboardExpand all lines: docs/intro/getting-started.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,13 @@
2
2
>
3
3
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
4
4
>
5
-
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/intro/n00b-gettingStarted.md](../../packages/mermaid/src/docs/intro/n00b-gettingStarted.md).
5
+
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/intro/getting-started.md](../../packages/mermaid/src/docs/intro/getting-started.md).
6
6
7
7
# A Mermaid User-Guide for Beginners
8
8
9
9
Mermaid is composed of three parts: Deployment, Syntax and Configuration.
10
10
11
-
This section talks about the different ways to deploy Mermaid. Learning the [Syntax](n00b-syntaxReference.md) would be of great help to the beginner.
11
+
This section talks about the different ways to deploy Mermaid. Learning the [Syntax](syntax-reference.md) would be of great help to the beginner.
12
12
13
13
> Generally the live editor is enough for most general uses of mermaid, and is a good place to start learning.
14
14
@@ -53,7 +53,7 @@ graph TD
53
53
54
54
In the `Code` section one can write or edit raw mermaid code, and instantly `Preview` the rendered result on the panel beside it.
55
55
56
-
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](../config/n00b-advanced.md) section. A complete configuration reference cataloging the default values can be found on the [mermaidAPI](../config/setup/README.md) page.
56
+
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](../config/advanced.md) section. A complete configuration reference cataloging the default values can be found on the [mermaidAPI](../config/setup/README.md) page.
57
57
58
58
Copy file name to clipboardExpand all lines: docs/intro/index.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@
10
10
11
11
It is a JavaScript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically.
12
12
13
-
> If you are familiar with Markdown you should have no problem learning [Mermaid's Syntax](n00b-syntaxReference.md).
13
+
> If you are familiar with Markdown you should have no problem learning [Mermaid's Syntax](syntax-reference.md).
14
14
15
15
<imgsrc="/header.png"alt="" />
16
16
@@ -44,7 +44,7 @@ Mermaid allows even non-programmers to easily create detailed and diagrams throu
44
44
[Tutorials](../config/Tutorials.md) has video tutorials.
45
45
Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](../ecosystem/integrations.md).
46
46
47
-
For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](../intro/n00b-gettingStarted.md) and [Usage](../config/usage.md).
47
+
For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](../intro/getting-started.md) and [Usage](../config/usage.md).
Copy file name to clipboardExpand all lines: docs/intro/syntax-reference.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
>
3
3
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
4
4
>
5
-
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/intro/n00b-syntaxReference.md](../../packages/mermaid/src/docs/intro/n00b-syntaxReference.md).
5
+
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/intro/syntax-reference.md](../../packages/mermaid/src/docs/intro/syntax-reference.md).
6
6
7
7
# Diagram Syntax
8
8
@@ -42,7 +42,7 @@ erDiagram
42
42
PRODUCT ||--o{ ORDER-ITEM : "ordered in"
43
43
```
44
44
45
-
The [Getting Started](./n00b-gettingStarted.md) section can also provide some practical examples of mermaid syntax.
45
+
The [Getting Started](./getting-started.md) section can also provide some practical examples of mermaid syntax.
46
46
47
47
## Diagram Breaking
48
48
@@ -66,20 +66,20 @@ Configuration is the third part of Mermaid, after deployment and syntax. It deal
66
66
67
67
If you are interested in altering and customizing your Mermaid Diagrams, you will find the methods and values available for [Configuration](../config/setup/README.md) here. It includes themes.
68
68
This section will introduce the different methods of configuring the behaviors and appearances of Mermaid Diagrams.
69
-
The following are the most commonly used methods, and they are all tied to Mermaid [Deployment](./n00b-gettingStarted.md) methods.
69
+
The following are the most commonly used methods, and they are all tied to Mermaid [Deployment](./getting-started.md) methods.
70
70
71
71
### Configuration Section in the [Live Editor](https://mermaid.live).
72
72
73
73
Here you can edit certain values to change the behavior and appearance of the diagram.
Used when Mermaid is called via an API, or through a `<script>` tag.
78
78
79
-
### [Directives](../config/directives.md),
79
+
### [Directives](../config/directives.md)
80
80
81
81
Allows for the limited reconfiguration of a diagram just before it is rendered. It can alter the font style, color and other aesthetic aspects of the diagram. You can pass a directive alongside your definition inside `%%{ }%%`. It can be done either above or below your diagram definition.
82
82
83
-
### [Theme Manipulation](../config/theming.md):
83
+
### [Theme Manipulation](../config/theming.md)
84
84
85
85
An application of using Directives to change [Themes](../config/theming.md). `Theme` is a value within Mermaid's configuration that dictates the color scheme for diagrams.
Copy file name to clipboardExpand all lines: packages/mermaid/src/docs/intro/getting-started.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Mermaid is composed of three parts: Deployment, Syntax and Configuration.
4
4
5
-
This section talks about the different ways to deploy Mermaid. Learning the [Syntax](n00b-syntaxReference.md) would be of great help to the beginner.
5
+
This section talks about the different ways to deploy Mermaid. Learning the [Syntax](syntax-reference.md) would be of great help to the beginner.
6
6
7
7
> Generally the live editor is enough for most general uses of mermaid, and is a good place to start learning.
8
8
@@ -36,7 +36,7 @@ graph TD
36
36
37
37
In the `Code` section one can write or edit raw mermaid code, and instantly `Preview` the rendered result on the panel beside it.
38
38
39
-
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](../config/n00b-advanced.md) section. A complete configuration reference cataloging the default values can be found on the [mermaidAPI](../config/setup/README.md) page.
39
+
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](../config/advanced.md) section. A complete configuration reference cataloging the default values can be found on the [mermaidAPI](../config/setup/README.md) page.
40
40
41
41
Copy file name to clipboardExpand all lines: packages/mermaid/src/docs/intro/index.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
It is a JavaScript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically.
6
6
7
-
> If you are familiar with Markdown you should have no problem learning [Mermaid's Syntax](n00b-syntaxReference.md).
7
+
> If you are familiar with Markdown you should have no problem learning [Mermaid's Syntax](syntax-reference.md).
8
8
9
9
<imgsrc="/header.png"alt="" />
10
10
@@ -39,7 +39,7 @@ Mermaid allows even non-programmers to easily create detailed and diagrams throu
39
39
[Tutorials](../config/Tutorials.md) has video tutorials.
40
40
Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](../ecosystem/integrations.md).
41
41
42
-
For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](../intro/n00b-gettingStarted.md) and [Usage](../config/usage.md).
42
+
For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](../intro/getting-started.md) and [Usage](../config/usage.md).
Copy file name to clipboardExpand all lines: packages/mermaid/src/docs/intro/syntax-reference.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ erDiagram
24
24
PRODUCT ||--o{ ORDER-ITEM : "ordered in"
25
25
```
26
26
27
-
The [Getting Started](./n00b-gettingStarted.md) section can also provide some practical examples of mermaid syntax.
27
+
The [Getting Started](./getting-started.md) section can also provide some practical examples of mermaid syntax.
28
28
29
29
## Diagram Breaking
30
30
@@ -48,20 +48,20 @@ Configuration is the third part of Mermaid, after deployment and syntax. It deal
48
48
49
49
If you are interested in altering and customizing your Mermaid Diagrams, you will find the methods and values available for [Configuration](../config/setup/README.md) here. It includes themes.
50
50
This section will introduce the different methods of configuring the behaviors and appearances of Mermaid Diagrams.
51
-
The following are the most commonly used methods, and they are all tied to Mermaid [Deployment](./n00b-gettingStarted.md) methods.
51
+
The following are the most commonly used methods, and they are all tied to Mermaid [Deployment](./getting-started.md) methods.
52
52
53
53
### Configuration Section in the [Live Editor](https://mermaid.live).
54
54
55
55
Here you can edit certain values to change the behavior and appearance of the diagram.
Used when Mermaid is called via an API, or through a `<script>` tag.
60
60
61
-
### [Directives](../config/directives.md),
61
+
### [Directives](../config/directives.md)
62
62
63
63
Allows for the limited reconfiguration of a diagram just before it is rendered. It can alter the font style, color and other aesthetic aspects of the diagram. You can pass a directive alongside your definition inside `%%{ }%%`. It can be done either above or below your diagram definition.
64
64
65
-
### [Theme Manipulation](../config/theming.md):
65
+
### [Theme Manipulation](../config/theming.md)
66
66
67
67
An application of using Directives to change [Themes](../config/theming.md). `Theme` is a value within Mermaid's configuration that dictates the color scheme for diagrams.
0 commit comments