From d473f3904a1464763d2d57bcd6f9a0922e0e3d2f Mon Sep 17 00:00:00 2001 From: Lishid Date: Thu, 22 Oct 2020 21:55:13 -0400 Subject: [PATCH 01/15] Fixed bad tertiary operator This fixes the tertiary operator used to compute the `edgeLabelBackground` theme variable. --- src/themes/theme-base.js | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/themes/theme-base.js b/src/themes/theme-base.js index e90a1b0f5..633212e92 100644 --- a/src/themes/theme-base.js +++ b/src/themes/theme-base.js @@ -63,10 +63,8 @@ class Theme { this.clusterBorder = this.clusterBorder || this.tertiaryBorderColor; this.defaultLinkColor = this.defaultLinkColor || this.lineColor; this.titleColor = this.titleColor || this.tertiaryTextColor; - this.edgeLabelBackground = - this.edgeLabelBackground || this.darkMode - ? darken(this.secondaryColor, 30) - : this.secondaryColor; + this.edgeLabelBackground = this.edgeLabelBackground || + (this.darkMode ? darken(this.secondaryColor, 30) : this.secondaryColor); this.nodeTextColor = this.nodeTextColor || this.primaryTextColor; /* Sequence Diagram variables */ From 521bfc66f03f44eaa971943ea566b403506fa3b6 Mon Sep 17 00:00:00 2001 From: Lishid Date: Thu, 22 Oct 2020 22:14:10 -0400 Subject: [PATCH 02/15] Update theme-base.js --- src/themes/theme-base.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/themes/theme-base.js b/src/themes/theme-base.js index 633212e92..49d3d8c5a 100644 --- a/src/themes/theme-base.js +++ b/src/themes/theme-base.js @@ -63,8 +63,8 @@ class Theme { this.clusterBorder = this.clusterBorder || this.tertiaryBorderColor; this.defaultLinkColor = this.defaultLinkColor || this.lineColor; this.titleColor = this.titleColor || this.tertiaryTextColor; - this.edgeLabelBackground = this.edgeLabelBackground || - (this.darkMode ? darken(this.secondaryColor, 30) : this.secondaryColor); + this.edgeLabelBackground = + this.edgeLabelBackground || (this.darkMode ? darken(this.secondaryColor, 30) : this.secondaryColor); this.nodeTextColor = this.nodeTextColor || this.primaryTextColor; /* Sequence Diagram variables */ From 69113a988f7f24f3350a58181b560f23d5248367 Mon Sep 17 00:00:00 2001 From: Lishid Date: Thu, 22 Oct 2020 22:17:43 -0400 Subject: [PATCH 03/15] Update theme-base.js --- src/themes/theme-base.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/themes/theme-base.js b/src/themes/theme-base.js index 49d3d8c5a..fdf5d8848 100644 --- a/src/themes/theme-base.js +++ b/src/themes/theme-base.js @@ -64,7 +64,8 @@ class Theme { this.defaultLinkColor = this.defaultLinkColor || this.lineColor; this.titleColor = this.titleColor || this.tertiaryTextColor; this.edgeLabelBackground = - this.edgeLabelBackground || (this.darkMode ? darken(this.secondaryColor, 30) : this.secondaryColor); + this.edgeLabelBackground || + (this.darkMode ? darken(this.secondaryColor, 30) : this.secondaryColor); this.nodeTextColor = this.nodeTextColor || this.primaryTextColor; /* Sequence Diagram variables */ From b89f79d90132fd9193bd28b66329f6fdf54748f6 Mon Sep 17 00:00:00 2001 From: Levente Laszlo Date: Thu, 29 Oct 2020 20:21:21 +0100 Subject: [PATCH 04/15] fix broken links in README --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4451bef6d..c759ebed2 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,12 @@ Mermaid addresses this problem by cutting the time, effort and tooling that is r The text definitions for Mermaid diagrams allows for it to be updated easily, it can also be made part of production scripts (and other pieces of code). So less time needs be spent on documenting, as a separate and laborious task.
Even non-programmers can create diagrams through the [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor).
-[Tutorials](./docs/getting-started/Tutorials.md) has video tutorials. -Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](./docs/overview/integrations.md). +[Tutorials](./docs/Tutorials.md) has video tutorials. +Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](./docs/integrations.md). -For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/overview/n00b-overview.md) and [Usage](./docs/getting-started/usage.md). +For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/n00b-overview.md) and [Usage](./docs/usage.md). -🌐 [CDN](https://unpkg.com/mermaid/) | πŸ“– [Documentation](https://mermaidjs.github.io) | πŸ™Œ [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) | πŸ“œ [Changelog](./docs/tutorials-and-community/CHANGELOG.md) +🌐 [CDN](https://unpkg.com/mermaid/) | πŸ“– [Documentation](https://mermaidjs.github.io) | πŸ™Œ [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) | πŸ“œ [Changelog](./docs/CHANGELOG.md) From aba8c0356abcbba778d6d4ce61dfe76e59528afd Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 30 Oct 2020 17:57:36 -0700 Subject: [PATCH 05/15] Update README.md --- docs/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index 08074e170..d4da65c66 100644 --- a/docs/README.md +++ b/docs/README.md @@ -154,9 +154,10 @@ journey ![Journey diagram](img/user-journey.png) # Installation -## In depth guides and examples can be found in [Getting Started](getting-started/n00b-gettingStarted.md) and [Usage](getting-started/usage.md). -## It would also be helpful to learn more about mermaid's [Syntax](diagrams-and-syntax-and-examples/n00b-syntaxReference.md). +**In depth guides and examples can be found in [Getting Started](docs/n00b-gettingStarted.md) and [Usage](docs/usage.md).** + +**It would also be helpful to learn more about mermaid's [Syntax](docs/n00b-syntaxReference.md).** ### CDN @@ -195,7 +196,7 @@ To support mermaid on your website, all you have to do is add Mermaid’s JavaSc ``` ## Doing so will command the mermaid parser to look for the `
` tags with `class="mermaid"` in your HTML Document. From these tags mermaid will try to read the diagram/chart definitons and render them as svg charts. -## Examples can be found in [Getting Started](getting-started/n00b-gettingStarted.md) +## Examples can be found in [Getting Started](docs/n00b-gettingStarted.md) # Sibling projects - [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor) From bf2376d5045a20e455d148ade5d40e06b62f2f97 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 30 Oct 2020 17:58:34 -0700 Subject: [PATCH 06/15] Update README.md --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index d4da65c66..6320c284b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -155,9 +155,9 @@ journey # Installation -**In depth guides and examples can be found in [Getting Started](docs/n00b-gettingStarted.md) and [Usage](docs/usage.md).** +**In depth guides and examples can be found in [Getting Started](/n00b-gettingStarted.md) and [Usage](/usage.md).** -**It would also be helpful to learn more about mermaid's [Syntax](docs/n00b-syntaxReference.md).** +**It would also be helpful to learn more about mermaid's [Syntax](/n00b-syntaxReference.md).** ### CDN From a3b8c84e39e2f14726b6ad9b6353593ae1b84f11 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 30 Oct 2020 17:58:42 -0700 Subject: [PATCH 07/15] Update README.md From d034e32703520be004422421e24db4fdc15c280a Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 30 Oct 2020 17:59:54 -0700 Subject: [PATCH 08/15] Update README.md --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 6320c284b..7ce534080 100644 --- a/docs/README.md +++ b/docs/README.md @@ -25,7 +25,7 @@ With Mermaid less time needs to be spent on making diagrams, as a separate docum Even non-programmers can create diagrams through the [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor), Visit the [Tutorials Page](https://github.com/mermaid-js/mermaid/blob/develop/docs/getting-started/Tutorials.md) for the Live Editor video tutorials. -Want to see what can be built with mermaid, or what applications already support it? Read the [Integrations and Usages for Mermaid](overview/integrations.md). +Want to see what can be built with mermaid, or what applications already support it? Read the [Integrations and Usages for Mermaid](./integrations.md). For a more detailed introduction to Mermaid and some of it's more basic uses, look to the [Beginner's Guide](overview/n00b-overview.md) and [Usage](getting-started/usage.md). From 5cb735eb8ff9a1a15ed9ae6234ea1a5484ca16f7 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 30 Oct 2020 18:02:26 -0700 Subject: [PATCH 09/15] Update README.md --- docs/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index 7ce534080..8d7b7e37b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -27,7 +27,7 @@ Even non-programmers can create diagrams through the [Mermaid Live Editor](https Want to see what can be built with mermaid, or what applications already support it? Read the [Integrations and Usages for Mermaid](./integrations.md). -For a more detailed introduction to Mermaid and some of it's more basic uses, look to the [Beginner's Guide](overview/n00b-overview.md) and [Usage](getting-started/usage.md). +For a more detailed introduction to Mermaid and some of it's more basic uses, look to the [Beginner's Guide](./n00b-overview.md) and [Usage](./usage.md). 🌐 [CDN](https://unpkg.com/mermaid/) | πŸ“– [Documentation](https://mermaidjs.github.io) | πŸ™Œ [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/docs/tutorials-and-community/development.md) | πŸ“œ [Version Log](tutorials-and-community/CHANGELOG.md) @@ -155,9 +155,9 @@ journey # Installation -**In depth guides and examples can be found in [Getting Started](/n00b-gettingStarted.md) and [Usage](/usage.md).** +**In depth guides and examples can be found in [Getting Started](./n00b-gettingStarted.md) and [Usage](./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](./n00b-syntaxReference.md).** ### CDN @@ -196,7 +196,7 @@ To support mermaid on your website, all you have to do is add Mermaid’s JavaSc ``` ## Doing so will command the mermaid parser to look for the `
` tags with `class="mermaid"` in your HTML Document. From these tags mermaid will try to read the diagram/chart definitons and render them as svg charts. -## Examples can be found in [Getting Started](docs/n00b-gettingStarted.md) +## Examples can be found in [Getting Started](./n00b-gettingStarted.md) # Sibling projects - [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor) From 48089e869e5419c3ea89a4f6b3901dbfe431f34c Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 30 Oct 2020 18:06:57 -0700 Subject: [PATCH 10/15] Update README.md --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 8d7b7e37b..ee69ee7bb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -29,7 +29,7 @@ Want to see what can be built with mermaid, or what applications already support For a more detailed introduction to Mermaid and some of it's more basic uses, look to the [Beginner's Guide](./n00b-overview.md) and [Usage](./usage.md). -🌐 [CDN](https://unpkg.com/mermaid/) | πŸ“– [Documentation](https://mermaidjs.github.io) | πŸ™Œ [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/docs/tutorials-and-community/development.md) | πŸ“œ [Version Log](tutorials-and-community/CHANGELOG.md) +🌐 [CDN](https://unpkg.com/mermaid/) | πŸ“– [Documentation](https://mermaidjs.github.io) | πŸ™Œ [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/docs/tutorials-and-community/development.md) | πŸ“œ [Version Log](./CHANGELOG.md) > πŸ–– Keep a steady pulse: mermaid needs more Collaborators, [Read More](https://github.com/knsv/mermaid/issues/866). From 2c6329310ad4e03b640d810bdba981278ef0116c Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 30 Oct 2020 18:09:31 -0700 Subject: [PATCH 11/15] Update README.md --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index ee69ee7bb..32ce07ff4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -23,13 +23,13 @@ With Mermaid less time needs to be spent on making diagrams, as a separate docum > Mermaid is a Diagramming tool for everyone. -Even non-programmers can create diagrams through the [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor), Visit the [Tutorials Page](https://github.com/mermaid-js/mermaid/blob/develop/docs/getting-started/Tutorials.md) for the Live Editor video tutorials. +Even non-programmers can create diagrams through the [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor), Visit the [Tutorials Page](https://github.com/mermaid-js/mermaid/blob/develop/docs/Tutorials.md) for the Live Editor video tutorials. Want to see what can be built with mermaid, or what applications already support it? Read the [Integrations and Usages for Mermaid](./integrations.md). For a more detailed introduction to Mermaid and some of it's more basic uses, look to the [Beginner's Guide](./n00b-overview.md) and [Usage](./usage.md). -🌐 [CDN](https://unpkg.com/mermaid/) | πŸ“– [Documentation](https://mermaidjs.github.io) | πŸ™Œ [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/docs/tutorials-and-community/development.md) | πŸ“œ [Version Log](./CHANGELOG.md) +🌐 [CDN](https://unpkg.com/mermaid/) | πŸ“– [Documentation](https://mermaidjs.github.io) | πŸ™Œ [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/docs/development.md) | πŸ“œ [Version Log](./CHANGELOG.md) > πŸ–– Keep a steady pulse: mermaid needs more Collaborators, [Read More](https://github.com/knsv/mermaid/issues/866). From 17d9f4fb4643db5f7d76c614cb4e14dfc342e170 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 30 Oct 2020 18:11:35 -0700 Subject: [PATCH 12/15] Update README.md --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 32ce07ff4..1d1621707 100644 --- a/docs/README.md +++ b/docs/README.md @@ -189,12 +189,12 @@ To support mermaid on your website, all you have to do is add Mermaid’s JavaSc ``` -## 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: +**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:** ```html ``` -## Doing so will command the mermaid parser to look for the `
` tags with `class="mermaid"` in your HTML Document. From these tags mermaid will try to read the diagram/chart definitons and render them as svg charts. +**Doing so will command the mermaid parser to look for the `
` tags with `class="mermaid"` in your HTML Document. From these tags mermaid will try to read the diagram/chart definitons and render them as svg charts.** ## Examples can be found in [Getting Started](./n00b-gettingStarted.md) From 6363cb0d8063145378f5ecfad7499824c5153a9f Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Fri, 30 Oct 2020 18:14:10 -0700 Subject: [PATCH 13/15] Update README.md --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 1d1621707..babbe9ae3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -173,7 +173,7 @@ Alternatively, you can also adjust the version number in the page itself. Latest Version: [https://unpkg.com/browse/mermaid@8.8.0/](https://unpkg.com/browse/mermaid@8.8.0/) -## Incorporating mermaid to a website +## Mermaid on a website To support mermaid on your website, all you have to do is add Mermaid’s JavaScript package ``` From e57120fa61e78f30b8b85f273332a5a80a9d6aec Mon Sep 17 00:00:00 2001 From: Knut Sveidqvist Date: Sat, 31 Oct 2020 11:14:39 +0100 Subject: [PATCH 14/15] Version update in package.json to 8.8.3 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 7c06d8a3b..9945ac450 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mermaid", - "version": "8.8.2", + "version": "8.8.3", "description": "Markdownish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.", "main": "dist/mermaid.core.js", "keywords": [ From 855dec7fcd23ae9b84283293417c8908186668f6 Mon Sep 17 00:00:00 2001 From: Knut Sveidqvist Date: Sun, 1 Nov 2020 11:08:47 +0100 Subject: [PATCH 15/15] Fix for build --- docs/flowchart.md | 4 ---- docs/index.html | 2 +- package.json | 2 +- 3 files changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/flowchart.md b/docs/flowchart.md index 85b76de2d..658f9c4bc 100644 --- a/docs/flowchart.md +++ b/docs/flowchart.md @@ -161,18 +161,14 @@ graph LR ``` ### A hexagon node -{% raw %} ``` graph LR id1{{This is the text in the box}} ``` -{% endraw %} ```mermaid -{% raw %} graph LR id1{{This is the text in the box}} -{% endraw %} ``` ### Parallelogram diff --git a/docs/index.html b/docs/index.html index 2814a046a..0e39d5f5e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,7 +7,7 @@ - +