mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-11-20 04:34:08 +01:00
Removed all n00b file names and added redirects
This commit is contained in:
@@ -7,7 +7,7 @@ services:
|
|||||||
working_dir: /mermaid
|
working_dir: /mermaid
|
||||||
mem_limit: '2G'
|
mem_limit: '2G'
|
||||||
environment:
|
environment:
|
||||||
- NODE_OPTIONS=--max_old_space_size=2048
|
- NODE_OPTIONS=--max_old_space_size=4096
|
||||||
volumes:
|
volumes:
|
||||||
- ./:/mermaid
|
- ./:/mermaid
|
||||||
- root_cache:/root/.cache
|
- root_cache:/root/.cache
|
||||||
|
|||||||
@@ -109,8 +109,8 @@ function sidebarAll() {
|
|||||||
collapsed: false,
|
collapsed: false,
|
||||||
items: [
|
items: [
|
||||||
{ text: 'About Mermaid', link: '/intro/' },
|
{ text: 'About Mermaid', link: '/intro/' },
|
||||||
{ text: 'Getting Started', link: '/intro/n00b-gettingStarted' },
|
{ text: 'Getting Started', link: '/intro/getting-started' },
|
||||||
{ text: 'Syntax and Configuration', link: '/intro/n00b-syntaxReference' },
|
{ text: 'Syntax and Configuration', link: '/intro/syntax-reference' },
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
...sidebarSyntax(),
|
...sidebarSyntax(),
|
||||||
@@ -167,7 +167,7 @@ function sidebarConfig() {
|
|||||||
{ text: 'Theming', link: '/config/theming' },
|
{ text: 'Theming', link: '/config/theming' },
|
||||||
{ text: 'Accessibility', link: '/config/accessibility' },
|
{ text: 'Accessibility', link: '/config/accessibility' },
|
||||||
{ text: 'Mermaid CLI', link: '/config/mermaidCLI' },
|
{ text: 'Mermaid CLI', link: '/config/mermaidCLI' },
|
||||||
{ text: 'Advanced usage', link: '/config/n00b-advanced' },
|
{ text: 'Advanced usage', link: '/config/advanced' },
|
||||||
{ text: 'FAQ', link: '/config/faq' },
|
{ text: 'FAQ', link: '/config/faq' },
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -19,8 +19,8 @@ test.each([
|
|||||||
'https://mermaid-js.github.io/mermaid/#/flowchart?another=test&id=my-id&one=more', // with multiple params
|
'https://mermaid-js.github.io/mermaid/#/flowchart?another=test&id=my-id&one=more', // with multiple params
|
||||||
'syntax/flowchart.html#my-id',
|
'syntax/flowchart.html#my-id',
|
||||||
],
|
],
|
||||||
['https://mermaid-js.github.io/mermaid/#/n00b-advanced', 'config/n00b-advanced.html'], // without .md
|
['https://mermaid-js.github.io/mermaid/#/n00b-advanced', 'config/advanced.html'], // without .md
|
||||||
['https://mermaid-js.github.io/mermaid/#/n00b-advanced.md', 'config/n00b-advanced.html'], // with .md
|
['https://mermaid-js.github.io/mermaid/#/n00b-advanced.md', 'config/advanced.html'], // with .md
|
||||||
[
|
[
|
||||||
'https://mermaid-js.github.io/mermaid/#/flowchart?id=a-node-in-the-form-of-a-circle', // with id, without .md
|
'https://mermaid-js.github.io/mermaid/#/flowchart?id=a-node-in-the-form-of-a-circle', // with id, without .md
|
||||||
'syntax/flowchart.html#a-node-in-the-form-of-a-circle',
|
'syntax/flowchart.html#a-node-in-the-form-of-a-circle',
|
||||||
|
|||||||
@@ -50,15 +50,18 @@ const idRedirectMap: Record<string, string> = {
|
|||||||
mermaidcli: 'config/mermaidCLI',
|
mermaidcli: 'config/mermaidCLI',
|
||||||
mindmap: 'syntax/mindmap',
|
mindmap: 'syntax/mindmap',
|
||||||
'more-pages': '',
|
'more-pages': '',
|
||||||
'n00b-advanced': 'config/n00b-advanced',
|
'n00b-advanced': 'config/advanced',
|
||||||
'n00b-gettingstarted': 'intro/n00b-gettingStarted',
|
'config/n00b-advanced': 'config/advanced',
|
||||||
'n00b-overview': 'intro/n00b-gettingStarted',
|
'n00b-gettingstarted': 'intro/getting-started',
|
||||||
'community/n00b-overview': 'intro/n00b-gettingStarted',
|
'intro/n00b-gettingStarted': 'intro/getting-started',
|
||||||
'n00b-syntaxreference': 'intro/n00b-syntaxReference',
|
'n00b-overview': 'intro/getting-started',
|
||||||
|
'n00b-syntaxreference': 'intro/syntax-reference',
|
||||||
|
'intro/n00b-syntaxReference': 'intro/syntax-reference',
|
||||||
|
'community/n00b-overview': 'intro/getting-started',
|
||||||
newdiagram: 'community/newDiagram',
|
newdiagram: 'community/newDiagram',
|
||||||
pie: 'syntax/pie',
|
pie: 'syntax/pie',
|
||||||
plugins: '',
|
plugins: '',
|
||||||
quickstart: 'intro/n00b-gettingStarted',
|
quickstart: 'intro/getting-started',
|
||||||
requirementdiagram: 'syntax/requirementDiagram',
|
requirementdiagram: 'syntax/requirementDiagram',
|
||||||
security: 'community/security',
|
security: 'community/security',
|
||||||
sequencediagram: 'syntax/sequenceDiagram',
|
sequencediagram: 'syntax/sequenceDiagram',
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ The definitions that can be generated the Live-Editor are also backwards-compati
|
|||||||
|
|
||||||
## Mermaid with HTML
|
## Mermaid with HTML
|
||||||
|
|
||||||
Examples are provided in [Getting Started](../intro/n00b-gettingStarted.md)
|
Examples are provided in [Getting Started](../intro/getting-started.md)
|
||||||
|
|
||||||
**CodePen Examples:**
|
**CodePen Examples:**
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# Advanced n00b mermaid (Coming soon..)
|
# Advanced mermaid (Coming soon..)
|
||||||
|
|
||||||
## splitting mermaid code from html
|
## splitting mermaid code from html
|
||||||
|
|
||||||
@@ -35,7 +35,7 @@ pnpm add mermaid
|
|||||||
|
|
||||||
**Hosting mermaid on a web page:**
|
**Hosting mermaid on a web page:**
|
||||||
|
|
||||||
> Note:This topic explored in greater depth in the [User Guide for Beginners](../intro/n00b-gettingStarted.md)
|
> Note:This topic explored in greater depth in the [User Guide for Beginners](../intro/getting-started.md)
|
||||||
|
|
||||||
The easiest way to integrate mermaid on a web page requires two elements:
|
The easiest way to integrate mermaid on a web page requires two elements:
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Mermaid is composed of three parts: Deployment, Syntax and Configuration.
|
Mermaid is composed of three parts: Deployment, Syntax and Configuration.
|
||||||
|
|
||||||
This section talks about the different ways to deploy Mermaid. Learning the [Syntax](n00b-syntaxReference.md) would be of great help to the beginner.
|
This section talks about the different ways to deploy Mermaid. Learning the [Syntax](syntax-reference.md) would be of great help to the beginner.
|
||||||
|
|
||||||
> Generally the live editor is enough for most general uses of mermaid, and is a good place to start learning.
|
> Generally the live editor is enough for most general uses of mermaid, and is a good place to start learning.
|
||||||
|
|
||||||
@@ -36,7 +36,7 @@ graph TD
|
|||||||
|
|
||||||
In the `Code` section one can write or edit raw mermaid code, and instantly `Preview` the rendered result on the panel beside it.
|
In the `Code` section one can write or edit raw mermaid code, and instantly `Preview` the rendered result on the panel beside it.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
It is a JavaScript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically.
|
It is a JavaScript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically.
|
||||||
|
|
||||||
> If you are familiar with Markdown you should have no problem learning [Mermaid's Syntax](n00b-syntaxReference.md).
|
> If you are familiar with Markdown you should have no problem learning [Mermaid's Syntax](syntax-reference.md).
|
||||||
|
|
||||||
<img src="/header.png" alt="" />
|
<img src="/header.png" alt="" />
|
||||||
|
|
||||||
@@ -39,7 +39,7 @@ Mermaid allows even non-programmers to easily create detailed and diagrams throu
|
|||||||
[Tutorials](../config/Tutorials.md) has video tutorials.
|
[Tutorials](../config/Tutorials.md) has video tutorials.
|
||||||
Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](../ecosystem/integrations.md).
|
Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](../ecosystem/integrations.md).
|
||||||
|
|
||||||
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).
|
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).
|
||||||
|
|
||||||
🌐 [CDN](https://www.jsdelivr.com/package/npm/mermaid) | 📖 [Documentation](https://mermaidjs.github.io) | 🙌 [Contribution](../community/development.md) | 🔌 [Plug-Ins](../ecosystem/integrations.md)
|
🌐 [CDN](https://www.jsdelivr.com/package/npm/mermaid) | 📖 [Documentation](https://mermaidjs.github.io) | 🙌 [Contribution](../community/development.md) | 🔌 [Plug-Ins](../ecosystem/integrations.md)
|
||||||
|
|
||||||
@@ -59,9 +59,9 @@ In our release process we rely heavily on visual regression tests using [applito
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
**In depth guides and examples can be found at [Getting Started](./n00b-gettingStarted.md) and [Usage](../config/usage.md).**
|
**In depth guides and examples can be found at [Getting Started](./getting-started.md) and [Usage](../config/usage.md).**
|
||||||
|
|
||||||
**It would also be helpful to learn more about mermaid's [Syntax](./n00b-syntaxReference.md).**
|
**It would also be helpful to learn more about mermaid's [Syntax](./syntax-reference.md).**
|
||||||
|
|
||||||
### CDN
|
### CDN
|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ erDiagram
|
|||||||
PRODUCT ||--o{ ORDER-ITEM : "ordered in"
|
PRODUCT ||--o{ ORDER-ITEM : "ordered in"
|
||||||
```
|
```
|
||||||
|
|
||||||
The [Getting Started](./n00b-gettingStarted.md) section can also provide some practical examples of mermaid syntax.
|
The [Getting Started](./getting-started.md) section can also provide some practical examples of mermaid syntax.
|
||||||
|
|
||||||
## Diagram Breaking
|
## Diagram Breaking
|
||||||
|
|
||||||
@@ -48,13 +48,13 @@ Configuration is the third part of Mermaid, after deployment and syntax. It deal
|
|||||||
|
|
||||||
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.
|
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.
|
||||||
This section will introduce the different methods of configuring the behaviors and appearances of Mermaid Diagrams.
|
This section will introduce the different methods of configuring the behaviors and appearances of Mermaid Diagrams.
|
||||||
The following are the most commonly used methods, and they are all tied to Mermaid [Deployment](./n00b-gettingStarted.md) methods.
|
The following are the most commonly used methods, and they are all tied to Mermaid [Deployment](./getting-started.md) methods.
|
||||||
|
|
||||||
### Configuration Section in the [Live Editor](https://mermaid.live).
|
### Configuration Section in the [Live Editor](https://mermaid.live).
|
||||||
|
|
||||||
Here you can edit certain values to change the behavior and appearance of the diagram.
|
Here you can edit certain values to change the behavior and appearance of the diagram.
|
||||||
|
|
||||||
### [The initialize() call](https://mermaid-js.github.io/mermaid/#/n00b-gettingStarted?id=_3-calling-the-javascript-api),
|
### [The initialize() call](https://mermaid-js.github.io/mermaid/#/getting-started?id=_3-calling-the-javascript-api),
|
||||||
|
|
||||||
Used when Mermaid is called via an API, or through a `<script>` tag.
|
Used when Mermaid is called via an API, or through a `<script>` tag.
|
||||||
|
|
||||||
2
pnpm-lock.yaml
generated
2
pnpm-lock.yaml
generated
@@ -15055,7 +15055,7 @@ packages:
|
|||||||
optional: true
|
optional: true
|
||||||
dependencies:
|
dependencies:
|
||||||
'@antfu/utils': 0.7.5
|
'@antfu/utils': 0.7.5
|
||||||
'@rollup/pluginutils': 5.0.2(rollup@2.79.1)
|
'@rollup/pluginutils': 5.0.3(rollup@2.79.1)
|
||||||
chokidar: 3.5.3
|
chokidar: 3.5.3
|
||||||
debug: 4.3.4(supports-color@8.1.1)
|
debug: 4.3.4(supports-color@8.1.1)
|
||||||
fast-glob: 3.3.1
|
fast-glob: 3.3.1
|
||||||
|
|||||||
Reference in New Issue
Block a user