From 0b543667056a00dc06e760eed1fb2b88ea739dbd Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 20:50:20 -0400 Subject: [PATCH 01/44] Add GH Action --- .github/workflows/docs.yml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000000..5cd3d65f48 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,28 @@ +name: Documentation Checks + +on: + push: + branches: + - develop + paths: + - "packages/mermaid/src/docs/**/*" + pull_request: + branches: + - develop + paths: + - "packages/mermaid/src/docs/**/*" +jobs: + spellcheck: + name: "Docs: Spellcheck" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + name: Check out the code + - uses: actions/setup-node@v1 + name: Setup node + with: + node-version: "16" + - run: npm install -g cspell + name: Install cSpell + - run: cspell --config ./cSpell.json "packages/mermaid/src/docs/**/*.md" --no-progress + name: run cSpell From 12e4819c49dde2d6f09c727d676a8acc570cafc7 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 20:50:23 -0400 Subject: [PATCH 02/44] Add cSpell config --- cSpell.json | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 cSpell.json diff --git a/cSpell.json b/cSpell.json new file mode 100644 index 0000000000..ba50fad44f --- /dev/null +++ b/cSpell.json @@ -0,0 +1,60 @@ +{ + "version": "0.2", + "language": "en", + "words": [ + ], + "ignoreWords": [ + ], + "patterns": [ + { + "name": "Markdown links", + "pattern": "\\((.*)\\)", + "description": "" + }, + { + "name": "Markdown code blocks", + "pattern": "/^(\\s*`{3,}).*[\\s\\S]*?^\\1/gmx", + "description": "Taken from the cSpell example at https://cspell.org/configuration/patterns/#verbose-regular-expressions" + }, + { + "name": "Inline code blocks", + "pattern": "\\`([^\\`\\r\\n]+?)\\`", + "description": "https://stackoverflow.com/questions/41274241/how-to-capture-inline-markdown-code-but-not-a-markdown-code-fence-with-regex" + }, + { + "name": "Link contents", + "pattern": "\\", + "description": "" + }, + { + "name": "Snippet references", + "pattern": "-- snippet:(.*)", + "description": "" + }, + { + "name": "Snippet references 2", + "pattern": "\\<\\[sample:(.*)", + "description": "another kind of snippet reference" + }, + { + "name": "Multi-line code blocks", + "pattern": "/^\\s*```[\\s\\S]*?^\\s*```/gm" + }, + { + "name": "HTML Tags", + "pattern": "<[^>]*>", + "description": "Reference: https://stackoverflow.com/questions/11229831/regular-expression-to-remove-html-tags-from-a-string" + } + ], + "ignoreRegExpList": [ + "Markdown links", + "Markdown code blocks", + "Inline code blocks", + "Link contents", + "Snippet references", + "Snippet references 2", + "Multi-line code blocks", + "HTML Tags" + ], + "ignorePaths": [] +} From b9fcb66d2811e05d0a67ce475a22ab6ee9d8baac Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:05:50 -0400 Subject: [PATCH 03/44] Add known words --- cSpell.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/cSpell.json b/cSpell.json index ba50fad44f..3d0a7360f4 100644 --- a/cSpell.json +++ b/cSpell.json @@ -2,9 +2,11 @@ "version": "0.2", "language": "en", "words": [ + "Gantt", + "Jaoude", + "redmine" ], - "ignoreWords": [ - ], + "ignoreWords": [], "patterns": [ { "name": "Markdown links", From ab2e727db9530b62f02cff618abf2ba293b91187 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:06:02 -0400 Subject: [PATCH 04/44] Back-ticks around non-word term --- packages/mermaid/src/docs/development.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/mermaid/src/docs/development.md b/packages/mermaid/src/docs/development.md index 80edb77197..37abe85ae4 100644 --- a/packages/mermaid/src/docs/development.md +++ b/packages/mermaid/src/docs/development.md @@ -22,9 +22,9 @@ This means that **you should branch off your pull request from develop** and dir ## Contributing Code -We make all changes via Pull Requests. As we have many Pull Requests from developers new to mermaid, we have put in place a process, wherein _knsv, Knut Sveidqvist_ is the primary reviewer of changes and merging pull requests. The process is as follows: +We make all changes via Pull Requests. As we have many Pull Requests from developers new to mermaid, we have put in place a process, wherein _`knsv`, Knut Sveidqvist_ is the primary reviewer of changes and merging pull requests. The process is as follows: -- Large changes reviewed by knsv or other developer asked to review by knsv +- Large changes reviewed by `knsv` or other developer asked to review by `knsv` - Smaller, low-risk changes like dependencies, documentation, etc. can be merged by active collaborators - Documentation (we encourage updates to the `src/docs` folder; you can submit them via direct commits) From e494e2dc56638b0914a09d61e4a2f4efe7daf2ad Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:06:11 -0400 Subject: [PATCH 05/44] Revert "Back-ticks around non-word term" This reverts commit ab2e727db9530b62f02cff618abf2ba293b91187. --- packages/mermaid/src/docs/development.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/mermaid/src/docs/development.md b/packages/mermaid/src/docs/development.md index 37abe85ae4..80edb77197 100644 --- a/packages/mermaid/src/docs/development.md +++ b/packages/mermaid/src/docs/development.md @@ -22,9 +22,9 @@ This means that **you should branch off your pull request from develop** and dir ## Contributing Code -We make all changes via Pull Requests. As we have many Pull Requests from developers new to mermaid, we have put in place a process, wherein _`knsv`, Knut Sveidqvist_ is the primary reviewer of changes and merging pull requests. The process is as follows: +We make all changes via Pull Requests. As we have many Pull Requests from developers new to mermaid, we have put in place a process, wherein _knsv, Knut Sveidqvist_ is the primary reviewer of changes and merging pull requests. The process is as follows: -- Large changes reviewed by `knsv` or other developer asked to review by `knsv` +- Large changes reviewed by knsv or other developer asked to review by knsv - Smaller, low-risk changes like dependencies, documentation, etc. can be merged by active collaborators - Documentation (we encourage updates to the `src/docs` folder; you can submit them via direct commits) From d24256e1c25338f73ba63a028a9fb175cd8f0f52 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:06:29 -0400 Subject: [PATCH 06/44] add knsv to dictionary --- cSpell.json | 1 + 1 file changed, 1 insertion(+) diff --git a/cSpell.json b/cSpell.json index 3d0a7360f4..342de825d8 100644 --- a/cSpell.json +++ b/cSpell.json @@ -4,6 +4,7 @@ "words": [ "Gantt", "Jaoude", + "knsv", "redmine" ], "ignoreWords": [], From c404f6fe346bb6223c7bd65e9195a26d79040203 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:09:28 -0400 Subject: [PATCH 07/44] add terms --- cSpell.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/cSpell.json b/cSpell.json index 342de825d8..0c46a67dc3 100644 --- a/cSpell.json +++ b/cSpell.json @@ -2,9 +2,13 @@ "version": "0.2", "language": "en", "words": [ + "customizability", "Gantt", + "Gitgraph", "Jaoude", "knsv", + "Mindmaps", + "Plantuml", "redmine" ], "ignoreWords": [], From ab1573053ecad8bd578fe65061dddba3499e2b98 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:10:50 -0400 Subject: [PATCH 08/44] add terms --- cSpell.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/cSpell.json b/cSpell.json index 0c46a67dc3..0b42889215 100644 --- a/cSpell.json +++ b/cSpell.json @@ -7,9 +7,12 @@ "Gitgraph", "Jaoude", "knsv", + "Knut", "Mindmaps", + "mitigations", "Plantuml", - "redmine" + "redmine", + "Sveidqvist" ], "ignoreWords": [], "patterns": [ From 3c4acd218407012ae33bb98fa4c449836425f103 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:11:39 -0400 Subject: [PATCH 09/44] back-ticks for non-word terms --- packages/mermaid/src/docs/Setup.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/mermaid/src/docs/Setup.md b/packages/mermaid/src/docs/Setup.md index aae2ae9c09..59d031189e 100644 --- a/packages/mermaid/src/docs/Setup.md +++ b/packages/mermaid/src/docs/Setup.md @@ -210,16 +210,16 @@ Default value: true ### defaultRenderer -| Parameter | Description | Type | Required | Values | -| --------------- | ----------- | ------- | -------- | ----------------------- | -| defaultRenderer | See notes | boolean | 4 | dagre-d3, dagre-wrapper | +| Parameter | Description | Type | Required | Values | +| --------------- | ----------- | ------- | -------- | --------------------------- | +| defaultRenderer | See notes | boolean | 4 | `dagre-d3`, `dagre-wrapper` | **Notes:** Decides which rendering engine that is to be used for the rendering. Legal values are: -dagre-d3 dagre-wrapper - wrapper for dagre implemented in mermaid +`dagre-d3` `dagre-wrapper` - wrapper for `dagre` implemented in mermaid -Default value: 'dagre-wrapper' +Default value: `dagre-wrapper` ## sequence From c10eb5af79e9b6b08fefeeda83519c9aaf331602 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:12:25 -0400 Subject: [PATCH 10/44] back-ticks for non-word terms --- packages/mermaid/src/docs/Setup.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/mermaid/src/docs/Setup.md b/packages/mermaid/src/docs/Setup.md index 59d031189e..949739296a 100644 --- a/packages/mermaid/src/docs/Setup.md +++ b/packages/mermaid/src/docs/Setup.md @@ -737,14 +737,14 @@ Default value: true | Parameter | Description | Type | Required | Values | | --------------- | ----------- | ------- | -------- | ----------------------- | -| defaultRenderer | See notes | boolean | 4 | dagre-d3, dagre-wrapper | +| defaultRenderer | See notes | boolean | 4 | `dagre-d3`, `dagre-wrapper` | **Notes**: Decides which rendering engine that is to be used for the rendering. Legal values are: -dagre-d3 dagre-wrapper - wrapper for dagre implemented in mermaid +`dagre-d3` `dagre-wrapper` - wrapper for `dagre` implemented in mermaid -Default value: 'dagre-d3' +Default value: `dagre-d3` ## useMaxWidth From a0c3de568bd244b9723eabcf5fbdef51fbe660fa Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:13:07 -0400 Subject: [PATCH 11/44] back-ticks for non-word terms --- packages/mermaid/src/docs/Setup.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/mermaid/src/docs/Setup.md b/packages/mermaid/src/docs/Setup.md index 949739296a..674de41122 100644 --- a/packages/mermaid/src/docs/Setup.md +++ b/packages/mermaid/src/docs/Setup.md @@ -763,14 +763,14 @@ Default value: true | Parameter | Description | Type | Required | Values | | --------------- | ----------- | ------- | -------- | ----------------------- | -| defaultRenderer | See notes | boolean | 4 | dagre-d3, dagre-wrapper | +| defaultRenderer | See notes | boolean | 4 | `dagre-d3`, `dagre-wrapper` | **Notes:** Decides which rendering engine that is to be used for the rendering. Legal values are: -dagre-d3 dagre-wrapper - wrapper for dagre implemented in mermaid +`dagre-d3` `dagre-wrapper` - wrapper for `dagre` implemented in mermaid -Default value: 'dagre-d3' +Default value: `dagre-d3` ## er From 86adf96021bebc9be0ff2ff13a65c291cc442a40 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:13:37 -0400 Subject: [PATCH 12/44] fix: boundaries --- packages/mermaid/src/docs/Setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/Setup.md b/packages/mermaid/src/docs/Setup.md index 674de41122..d17aec0ea7 100644 --- a/packages/mermaid/src/docs/Setup.md +++ b/packages/mermaid/src/docs/Setup.md @@ -992,7 +992,7 @@ Default value: 4 | --------------- | ----------- | ------- | -------- | ------------------ | | c4BoundaryInRow | See Notes | Integer | Required | Any Positive Value | -**Notes:** How many boundarys to place in each row. +**Notes:** How many boundaries to place in each row. Default value: 2 From 405df09e432e904840ffb74abb7a3d55397a7b49 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:15:32 -0400 Subject: [PATCH 13/44] standardization: "behavior" --- packages/mermaid/src/docs/Setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/Setup.md b/packages/mermaid/src/docs/Setup.md index d17aec0ea7..082f025229 100644 --- a/packages/mermaid/src/docs/Setup.md +++ b/packages/mermaid/src/docs/Setup.md @@ -119,7 +119,7 @@ Default value: ['secure', 'securityLevel', 'startOnLoad', 'maxTextSize'] This option controls if the generated ids of nodes in the SVG are generated randomly or based on a seed. If set to false, the IDs are generated based on the current date and thus are not -deterministic. This is the default behaviour. +deterministic. This is the default behavior. **Notes**: From 8cf4efc190bf550218c1daa11dc8a48cec59f066 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:15:50 -0400 Subject: [PATCH 14/44] fix: "source control" --- packages/mermaid/src/docs/Setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/Setup.md b/packages/mermaid/src/docs/Setup.md index 082f025229..5fd24fd6e0 100644 --- a/packages/mermaid/src/docs/Setup.md +++ b/packages/mermaid/src/docs/Setup.md @@ -123,7 +123,7 @@ deterministic. This is the default behavior. **Notes**: -This matters if your files are checked into sourcecontrol e.g. git and should not change unless +This matters if your files are checked into source control e.g. git and should not change unless content is changed. Default value: false From 4f91c9a8dea1bfaf278eb787b70022a61e0416a8 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:16:59 -0400 Subject: [PATCH 15/44] add known terms --- cSpell.json | 1 + 1 file changed, 1 insertion(+) diff --git a/cSpell.json b/cSpell.json index 0b42889215..36e0a37b40 100644 --- a/cSpell.json +++ b/cSpell.json @@ -12,6 +12,7 @@ "mitigations", "Plantuml", "redmine", + "sandboxed", "Sveidqvist" ], "ignoreWords": [], From 5390c409d00a4564dd8381c2b12732579c629801 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:17:11 -0400 Subject: [PATCH 16/44] back-ticks for non-word terms --- packages/mermaid/src/docs/Setup.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/mermaid/src/docs/Setup.md b/packages/mermaid/src/docs/Setup.md index 5fd24fd6e0..90e9edc915 100644 --- a/packages/mermaid/src/docs/Setup.md +++ b/packages/mermaid/src/docs/Setup.md @@ -72,15 +72,15 @@ Theme , the CSS style sheet | Parameter | Description | Type | Required | Values | | ------------- | --------------------------------- | ------ | -------- | ------------------------------------------ | -| securityLevel | Level of trust for parsed diagram | string | Required | 'sandbox', 'strict', 'loose', 'antiscript' | +| securityLevel | Level of trust for parsed diagram | string | Required | `sandbox`, `strict`, `loose`, `antiscript` | **Notes**: -- **strict**: (**default**) tags in text are encoded, click functionality is disabled -- **loose**: tags in text are allowed, click functionality is enabled -- **antiscript**: html tags in text are allowed, (only script element is removed), click +- **`strict`**: (**default**) tags in text are encoded, click functionality is disabled +- **`loose`**: tags in text are allowed, click functionality is enabled +- **`antiscript`**: html tags in text are allowed, (only script element is removed), click functionality is enabled -- **sandbox**: With this security level all rendering takes place in a sandboxed iframe. This +- **`sandbox`**: With this security level all rendering takes place in a sandboxed iframe. This prevent any JavaScript from running in the context. This may hinder interactive functionality of the diagram like scripts, popups in sequence diagram or links to other tabs/targets etc. From a1757ba21796dd5f6ad7742f2b69400e30be26e5 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:17:30 -0400 Subject: [PATCH 17/44] standardization: "sanitize" --- packages/mermaid/src/docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/README.md b/packages/mermaid/src/docs/README.md index e8bba38dae..6c26160581 100644 --- a/packages/mermaid/src/docs/README.md +++ b/packages/mermaid/src/docs/README.md @@ -279,7 +279,7 @@ Detailed information about how to contribute can be found in the [contribution g ## Security and safe diagrams -For public sites, it can be precarious to retrieve text from users on the internet, storing that content for presentation in a browser at a later stage. The reason is that the user content can contain embedded malicious scripts that will run when the data is presented. For Mermaid this is a risk, specially as mermaid diagrams contain many characters that are used in html which makes the standard sanitation unusable as it also breaks the diagrams. We still make an effort to sanitise the incoming code and keep refining the process but it is hard to guarantee that there are no loop holes. +For public sites, it can be precarious to retrieve text from users on the internet, storing that content for presentation in a browser at a later stage. The reason is that the user content can contain embedded malicious scripts that will run when the data is presented. For Mermaid this is a risk, specially as mermaid diagrams contain many characters that are used in html which makes the standard sanitation unusable as it also breaks the diagrams. We still make an effort to sanitize the incoming code and keep refining the process but it is hard to guarantee that there are no loop holes. As an extra level of security for sites with external users we are happy to introduce a new security level in which the diagram is rendered in a sandboxed iframe preventing JavaScript in the code from being executed. This is a great step forward for better security. From 2e72c0bf6eb1a9914d299820f8da139c5a0a61c9 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:17:56 -0400 Subject: [PATCH 18/44] add known term --- cSpell.json | 1 + 1 file changed, 1 insertion(+) diff --git a/cSpell.json b/cSpell.json index 36e0a37b40..4d000cce9a 100644 --- a/cSpell.json +++ b/cSpell.json @@ -2,6 +2,7 @@ "version": "0.2", "language": "en", "words": [ + "applitools", "customizability", "Gantt", "Gitgraph", From 6b736f0bb0777062e25309a864e997352354384e Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:18:34 -0400 Subject: [PATCH 19/44] add known term --- cSpell.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/cSpell.json b/cSpell.json index 4d000cce9a..4ef0284baf 100644 --- a/cSpell.json +++ b/cSpell.json @@ -7,6 +7,7 @@ "Gantt", "Gitgraph", "Jaoude", + "jison", "knsv", "Knut", "Mindmaps", @@ -14,7 +15,8 @@ "Plantuml", "redmine", "sandboxed", - "Sveidqvist" + "Sveidqvist", + "Visio" ], "ignoreWords": [], "patterns": [ From 3777ccb3053564b5252558726c0f1a4e595aac1a Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:19:26 -0400 Subject: [PATCH 20/44] more known terms --- cSpell.json | 1 + 1 file changed, 1 insertion(+) diff --git a/cSpell.json b/cSpell.json index 4ef0284baf..f7547c2e61 100644 --- a/cSpell.json +++ b/cSpell.json @@ -16,6 +16,7 @@ "redmine", "sandboxed", "Sveidqvist", + "verdana", "Visio" ], "ignoreWords": [], From b0ed5e9be2041b6856f287723972bfee10bc6304 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:19:33 -0400 Subject: [PATCH 21/44] turn npmjs.org into link --- packages/mermaid/src/docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/README.md b/packages/mermaid/src/docs/README.md index 6c26160581..9040eea392 100644 --- a/packages/mermaid/src/docs/README.md +++ b/packages/mermaid/src/docs/README.md @@ -263,7 +263,7 @@ Update version number in `package.json`. npm publish ``` -The above command generates files into the `dist` folder and publishes them to npmjs.org. +The above command generates files into the `dist` folder and publishes them to . ## Related projects From aacc40e525ca406330b1cb6e0497df1c4dc87793 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:20:14 -0400 Subject: [PATCH 22/44] add known term --- cSpell.json | 1 + 1 file changed, 1 insertion(+) diff --git a/cSpell.json b/cSpell.json index f7547c2e61..f7e57abf1d 100644 --- a/cSpell.json +++ b/cSpell.json @@ -13,6 +13,7 @@ "Mindmaps", "mitigations", "Plantuml", + "Playfair's", "redmine", "sandboxed", "Sveidqvist", From 56b9aab5cea2d37ebe2e0fc8c3550ae0cd72c817 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:20:28 -0400 Subject: [PATCH 23/44] fix: "previous" --- packages/mermaid/src/docs/mindmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/mindmap.md b/packages/mermaid/src/docs/mindmap.md index 85a05e04b5..c840f97ee5 100644 --- a/packages/mermaid/src/docs/mindmap.md +++ b/packages/mermaid/src/docs/mindmap.md @@ -31,7 +31,7 @@ mindmap The syntax for creating Mindmaps is simple and relies on indentation for setting the levels in the hierarchy. -In the following example you can see how there are 3 dufferent levels. One with starting at the left of the text and another level with two rows starting at the same column, defining the node A. At the end there is one more level where the text is indented further then the prevoius lines defining the nodes B and C. +In the following example you can see how there are 3 dufferent levels. One with starting at the left of the text and another level with two rows starting at the same column, defining the node A. At the end there is one more level where the text is indented further then the previous lines defining the nodes B and C. ``` mindmap From 0859f28a14a5127ed55120c84bcf314d7b1d7a49 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:20:37 -0400 Subject: [PATCH 24/44] fix: "different" --- packages/mermaid/src/docs/mindmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/mindmap.md b/packages/mermaid/src/docs/mindmap.md index c840f97ee5..188bc93d75 100644 --- a/packages/mermaid/src/docs/mindmap.md +++ b/packages/mermaid/src/docs/mindmap.md @@ -31,7 +31,7 @@ mindmap The syntax for creating Mindmaps is simple and relies on indentation for setting the levels in the hierarchy. -In the following example you can see how there are 3 dufferent levels. One with starting at the left of the text and another level with two rows starting at the same column, defining the node A. At the end there is one more level where the text is indented further then the previous lines defining the nodes B and C. +In the following example you can see how there are 3 different levels. One with starting at the left of the text and another level with two rows starting at the same column, defining the node A. At the end there is one more level where the text is indented further then the previous lines defining the nodes B and C. ``` mindmap From 9fe7152d9878aaba930a0026f0cfecfb07aeeb71 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:20:54 -0400 Subject: [PATCH 25/44] add known term --- cSpell.json | 1 + 1 file changed, 1 insertion(+) diff --git a/cSpell.json b/cSpell.json index f7e57abf1d..1c8e4058b1 100644 --- a/cSpell.json +++ b/cSpell.json @@ -10,6 +10,7 @@ "jison", "knsv", "Knut", + "mindmap", "Mindmaps", "mitigations", "Plantuml", From a4b0e6b87bd7d5bf30e262984c272ab356cb1392 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:21:14 -0400 Subject: [PATCH 26/44] known term --- cSpell.json | 1 + 1 file changed, 1 insertion(+) diff --git a/cSpell.json b/cSpell.json index 1c8e4058b1..b24cbfa3d5 100644 --- a/cSpell.json +++ b/cSpell.json @@ -3,6 +3,7 @@ "language": "en", "words": [ "applitools", + "Bisheng", "customizability", "Gantt", "Gitgraph", From b1f3e21d2832670d1e04800094aeb8671bc907b8 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:21:32 -0400 Subject: [PATCH 27/44] fix: "stable" --- packages/mermaid/src/docs/mindmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/mindmap.md b/packages/mermaid/src/docs/mindmap.md index 188bc93d75..af7a3df85e 100644 --- a/packages/mermaid/src/docs/mindmap.md +++ b/packages/mermaid/src/docs/mindmap.md @@ -1,6 +1,6 @@ # Mindmap -> Mindmap: This is an experimental diagram for now. The syntax and properties can change in future releases. The syntax is stabel except for the icon integration which is the experimental part. +> Mindmap: This is an experimental diagram for now. The syntax and properties can change in future releases. The syntax is stable except for the icon integration which is the experimental part. "A mind map is a diagram used to visually organize information into a hierarchy, showing relationships among pieces of the whole. It is often created around a single concept, drawn as an image in the center of a blank page, to which associated representations of ideas such as images, words and parts of words are added. Major ideas are connected directly to the central concept, and other ideas branch out from those major ideas." Wikipedia From ee45ab2e6c80d17a020e8a1e9cb0db1ba57fadf0 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:23:22 -0400 Subject: [PATCH 28/44] known terms --- cSpell.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/cSpell.json b/cSpell.json index b24cbfa3d5..19ca92776e 100644 --- a/cSpell.json +++ b/cSpell.json @@ -3,8 +3,11 @@ "language": "en", "words": [ "applitools", + "Asciidoctor", "Bisheng", + "codedoc", "customizability", + "Docsy", "Gantt", "Gitgraph", "Jaoude", @@ -14,10 +17,13 @@ "mindmap", "Mindmaps", "mitigations", + "mkdocs", "Plantuml", "Playfair's", + "Podlite", "redmine", "sandboxed", + "sphinxcontrib", "Sveidqvist", "verdana", "Visio" From 8215c7d98e038167184d5a7f2fcd1e8d4f861d09 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:24:00 -0400 Subject: [PATCH 29/44] known terms --- cSpell.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/cSpell.json b/cSpell.json index 19ca92776e..3f6fe90ad9 100644 --- a/cSpell.json +++ b/cSpell.json @@ -4,16 +4,20 @@ "words": [ "applitools", "Asciidoctor", + "Astah", "Bisheng", "codedoc", "customizability", "Docsy", "Gantt", "Gitgraph", + "Inkdrop", "Jaoude", "jison", "knsv", "Knut", + "mdbook", + "mermerd", "mindmap", "Mindmaps", "mitigations", From 0e61395aa9e332d06fe5d1b2d8ed0976585e2902 Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:24:32 -0400 Subject: [PATCH 30/44] fix: "JetBrains" --- packages/mermaid/src/docs/integrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/integrations.md b/packages/mermaid/src/docs/integrations.md index 2b25cb600b..fc300cd6be 100644 --- a/packages/mermaid/src/docs/integrations.md +++ b/packages/mermaid/src/docs/integrations.md @@ -31,7 +31,7 @@ They also serve as proof of concept, for the variety of things that can be built - [Mermaid Macro](https://www.redmine.org/plugins/redmine_mermaid_macro) - [redmine-mermaid](https://github.com/styz/redmine_mermaid) - [markdown-for-mermaid-plugin](https://github.com/jamieh-mongolian/markdown-for-mermaid-plugin) -- [Jetsbrain IDE eg Pycharm](https://www.jetbrains.com/go/guide/tips/mermaid-js-support-in-markdown/) +- [JetBrains IDE eg Pycharm](https://www.jetbrains.com/go/guide/tips/mermaid-js-support-in-markdown/) - [mermerd](https://github.com/KarnerTh/mermerd) ## CRM/ERP/Similar From 9c1da3bca16c2ad5e3e8078303972a572616924a Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:25:20 -0400 Subject: [PATCH 31/44] known terms --- cSpell.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/cSpell.json b/cSpell.json index 3f6fe90ad9..315f91f9cc 100644 --- a/cSpell.json +++ b/cSpell.json @@ -2,6 +2,7 @@ "version": "0.2", "language": "en", "words": [ + "Adamiecki", "applitools", "Asciidoctor", "Astah", @@ -10,6 +11,7 @@ "customizability", "Docsy", "Gantt", + "Gitea", "Gitgraph", "Inkdrop", "Jaoude", @@ -29,6 +31,7 @@ "sandboxed", "sphinxcontrib", "Sveidqvist", + "Tuleap", "verdana", "Visio" ], From 6d9b695adad6099b9a2b829469219539c16df22c Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:25:50 -0400 Subject: [PATCH 32/44] known terms --- cSpell.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/cSpell.json b/cSpell.json index 315f91f9cc..386556d937 100644 --- a/cSpell.json +++ b/cSpell.json @@ -10,9 +10,11 @@ "codedoc", "customizability", "Docsy", + "Doku", "Gantt", "Gitea", "Gitgraph", + "Grav", "Inkdrop", "Jaoude", "jison", @@ -24,6 +26,7 @@ "Mindmaps", "mitigations", "mkdocs", + "phpbb", "Plantuml", "Playfair's", "Podlite", From 034fe804118f43e256fafb52b591f4c52ec1007b Mon Sep 17 00:00:00 2001 From: Sean Killeen Date: Fri, 7 Oct 2022 21:26:16 -0400 Subject: [PATCH 33/44] fix: "corresponding" --- packages/mermaid/src/docs/accessibility.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/accessibility.md b/packages/mermaid/src/docs/accessibility.md index 387871de42..ade20a8395 100644 --- a/packages/mermaid/src/docs/accessibility.md +++ b/packages/mermaid/src/docs/accessibility.md @@ -17,7 +17,7 @@ The diagram authors can now add the accessibility options in the diagram definit - `accTitle: "Your Accessibility Title"` or - `accDescr: "Your Accessibility Description"` -**When these two options are defined, they will add a coressponding `` and `<desc>` tag in the SVG.** +**When these two options are defined, they will add a corresponding `<title>` and `<desc>` tag in the SVG.** Let us take a look at the following example with a flowchart diagram: From f31db315b8bad86ef98d1d0d1f9e28ea2ef8d3ea Mon Sep 17 00:00:00 2001 From: Sean Killeen <SeanKilleen@gmail.com> Date: Fri, 7 Oct 2022 21:30:10 -0400 Subject: [PATCH 34/44] fix: "skin param" --- cSpell.json | 5 ++++- packages/mermaid/src/docs/c4c.md | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/cSpell.json b/cSpell.json index 386556d937..31fd8db31d 100644 --- a/cSpell.json +++ b/cSpell.json @@ -7,6 +7,7 @@ "Asciidoctor", "Astah", "Bisheng", + "classdiagram", "codedoc", "customizability", "Docsy", @@ -90,5 +91,7 @@ "Multi-line code blocks", "HTML Tags" ], - "ignorePaths": [] + "ignorePaths": [ + "packages/mermaid/src/docs/CHANGELOG.md" + ] } diff --git a/packages/mermaid/src/docs/c4c.md b/packages/mermaid/src/docs/c4c.md index 0ab805182c..f9850f2cd3 100644 --- a/packages/mermaid/src/docs/c4c.md +++ b/packages/mermaid/src/docs/c4c.md @@ -131,7 +131,7 @@ The following unfinished features are not supported in the short term. - - [x] Rel_Back - - [x] RelIndex \* Compatible with C4-Plantuml syntax, but ignores the index parameter. The sequence number is determined by the order in which the rel statements are written. -- [ ] Custom tags/stereotypes support and skinparam updates +- [ ] Custom tags/stereotypes support and skin param updates - - [ ] AddElementTag(tagStereo, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new element tag. The styles of the tagged elements are updated and the tag is displayed in the calculated legend. - - [ ] AddRelTag(tagStereo, ?textColor, ?lineColor, ?lineStyle, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new Relationship tag. The styles of the tagged relationships are updated and the tag is displayed in the calculated legend. - - [x] UpdateElementStyle(elementName, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): This call updates the default style of the elements (component, ...) and creates no additional legend entry. From 18283bc48f352a95c5c4da3292cc03a688a181b1 Mon Sep 17 00:00:00 2001 From: Sean Killeen <SeanKilleen@gmail.com> Date: Fri, 7 Oct 2022 21:30:36 -0400 Subject: [PATCH 35/44] Revert "fix: "skin param"" This reverts commit f31db315b8bad86ef98d1d0d1f9e28ea2ef8d3ea. --- cSpell.json | 5 +---- packages/mermaid/src/docs/c4c.md | 2 +- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/cSpell.json b/cSpell.json index 31fd8db31d..386556d937 100644 --- a/cSpell.json +++ b/cSpell.json @@ -7,7 +7,6 @@ "Asciidoctor", "Astah", "Bisheng", - "classdiagram", "codedoc", "customizability", "Docsy", @@ -91,7 +90,5 @@ "Multi-line code blocks", "HTML Tags" ], - "ignorePaths": [ - "packages/mermaid/src/docs/CHANGELOG.md" - ] + "ignorePaths": [] } diff --git a/packages/mermaid/src/docs/c4c.md b/packages/mermaid/src/docs/c4c.md index f9850f2cd3..0ab805182c 100644 --- a/packages/mermaid/src/docs/c4c.md +++ b/packages/mermaid/src/docs/c4c.md @@ -131,7 +131,7 @@ The following unfinished features are not supported in the short term. - - [x] Rel_Back - - [x] RelIndex \* Compatible with C4-Plantuml syntax, but ignores the index parameter. The sequence number is determined by the order in which the rel statements are written. -- [ ] Custom tags/stereotypes support and skin param updates +- [ ] Custom tags/stereotypes support and skinparam updates - - [ ] AddElementTag(tagStereo, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new element tag. The styles of the tagged elements are updated and the tag is displayed in the calculated legend. - - [ ] AddRelTag(tagStereo, ?textColor, ?lineColor, ?lineStyle, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new Relationship tag. The styles of the tagged relationships are updated and the tag is displayed in the calculated legend. - - [x] UpdateElementStyle(elementName, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): This call updates the default style of the elements (component, ...) and creates no additional legend entry. From 01fac85cdecef46b4e451f114a13475914096b4e Mon Sep 17 00:00:00 2001 From: Sean Killeen <SeanKilleen@gmail.com> Date: Fri, 7 Oct 2022 21:31:00 -0400 Subject: [PATCH 36/44] ignore the changelog --- cSpell.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/cSpell.json b/cSpell.json index 386556d937..cd41eb6565 100644 --- a/cSpell.json +++ b/cSpell.json @@ -90,5 +90,7 @@ "Multi-line code blocks", "HTML Tags" ], - "ignorePaths": [] + "ignorePaths": [ + "packages/mermaid/src/docs/CHANGELOG.md" + ] } From 514d12d48cf7ea1368c99f97ac990e50f0837443 Mon Sep 17 00:00:00 2001 From: Sean Killeen <SeanKilleen@gmail.com> Date: Fri, 7 Oct 2022 21:31:18 -0400 Subject: [PATCH 37/44] fix: "skin param" --- packages/mermaid/src/docs/c4c.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/c4c.md b/packages/mermaid/src/docs/c4c.md index 0ab805182c..f9850f2cd3 100644 --- a/packages/mermaid/src/docs/c4c.md +++ b/packages/mermaid/src/docs/c4c.md @@ -131,7 +131,7 @@ The following unfinished features are not supported in the short term. - - [x] Rel_Back - - [x] RelIndex \* Compatible with C4-Plantuml syntax, but ignores the index parameter. The sequence number is determined by the order in which the rel statements are written. -- [ ] Custom tags/stereotypes support and skinparam updates +- [ ] Custom tags/stereotypes support and skin param updates - - [ ] AddElementTag(tagStereo, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new element tag. The styles of the tagged elements are updated and the tag is displayed in the calculated legend. - - [ ] AddRelTag(tagStereo, ?textColor, ?lineColor, ?lineStyle, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new Relationship tag. The styles of the tagged relationships are updated and the tag is displayed in the calculated legend. - - [x] UpdateElementStyle(elementName, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): This call updates the default style of the elements (component, ...) and creates no additional legend entry. From 8a3bd5bcb86fec7da75154dd6cb9c534aa0eac65 Mon Sep 17 00:00:00 2001 From: Sean Killeen <SeanKilleen@gmail.com> Date: Fri, 7 Oct 2022 21:34:40 -0400 Subject: [PATCH 38/44] separate words & ignoreWords --- cSpell.json | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/cSpell.json b/cSpell.json index cd41eb6565..0c555a6b8c 100644 --- a/cSpell.json +++ b/cSpell.json @@ -2,43 +2,44 @@ "version": "0.2", "language": "en", "words": [ - "Adamiecki", + "customizability", + "Gantt", + "jison", + "knsv", + "Knut", + "mindmap", + "Mindmaps", + "mitigations", + "sandboxed", + "Sveidqvist", + "verdana", + "Visio" + ], + "ignoreWords": [ + "Adamiecki", "applitools", "Asciidoctor", "Astah", "Bisheng", "codedoc", - "customizability", "Docsy", "Doku", - "Gantt", "Gitea", "Gitgraph", "Grav", "Inkdrop", "Jaoude", - "jison", - "knsv", - "Knut", - "mdbook", + "mdbook", "mermerd", - "mindmap", - "Mindmaps", - "mitigations", "mkdocs", "phpbb", "Plantuml", "Playfair's", "Podlite", "redmine", - "sandboxed", "sphinxcontrib", - "Sveidqvist", - "Tuleap", - "verdana", - "Visio" - ], - "ignoreWords": [], + "Tuleap" + ], "patterns": [ { "name": "Markdown links", From a22158b2e2133331b5f3317da3759c472ff9cf07 Mon Sep 17 00:00:00 2001 From: Sean Killeen <SeanKilleen@gmail.com> Date: Fri, 7 Oct 2022 21:37:40 -0400 Subject: [PATCH 39/44] format cSpell.json --- cSpell.json | 178 ++++++++++++++++++++++++++-------------------------- 1 file changed, 89 insertions(+), 89 deletions(-) diff --git a/cSpell.json b/cSpell.json index 0c555a6b8c..55b362daf1 100644 --- a/cSpell.json +++ b/cSpell.json @@ -1,96 +1,96 @@ { - "version": "0.2", - "language": "en", - "words": [ - "customizability", - "Gantt", - "jison", - "knsv", - "Knut", - "mindmap", - "Mindmaps", - "mitigations", - "sandboxed", - "Sveidqvist", - "verdana", - "Visio" - ], - "ignoreWords": [ + "version": "0.2", + "language": "en", + "words": [ + "customizability", + "Gantt", + "jison", + "knsv", + "Knut", + "mindmap", + "Mindmaps", + "mitigations", + "sandboxed", + "Sveidqvist", + "verdana", + "Visio" + ], + "ignoreWords": [ "Adamiecki", - "applitools", - "Asciidoctor", - "Astah", - "Bisheng", - "codedoc", - "Docsy", - "Doku", - "Gitea", - "Gitgraph", - "Grav", - "Inkdrop", - "Jaoude", + "applitools", + "Asciidoctor", + "Astah", + "Bisheng", + "codedoc", + "Docsy", + "Doku", + "Gitea", + "Gitgraph", + "Grav", + "Inkdrop", + "Jaoude", "mdbook", - "mermerd", - "mkdocs", - "phpbb", - "Plantuml", - "Playfair's", - "Podlite", - "redmine", - "sphinxcontrib", - "Tuleap" + "mermerd", + "mkdocs", + "phpbb", + "Plantuml", + "Playfair's", + "Podlite", + "redmine", + "sphinxcontrib", + "Tuleap" + ], + "patterns": [ + { + "name": "Markdown links", + "pattern": "\\((.*)\\)", + "description": "" + }, + { + "name": "Markdown code blocks", + "pattern": "/^(\\s*`{3,}).*[\\s\\S]*?^\\1/gmx", + "description": "Taken from the cSpell example at https://cspell.org/configuration/patterns/#verbose-regular-expressions" + }, + { + "name": "Inline code blocks", + "pattern": "\\`([^\\`\\r\\n]+?)\\`", + "description": "https://stackoverflow.com/questions/41274241/how-to-capture-inline-markdown-code-but-not-a-markdown-code-fence-with-regex" + }, + { + "name": "Link contents", + "pattern": "\\<a(.*)\\>", + "description": "" + }, + { + "name": "Snippet references", + "pattern": "-- snippet:(.*)", + "description": "" + }, + { + "name": "Snippet references 2", + "pattern": "\\<\\[sample:(.*)", + "description": "another kind of snippet reference" + }, + { + "name": "Multi-line code blocks", + "pattern": "/^\\s*```[\\s\\S]*?^\\s*```/gm" + }, + { + "name": "HTML Tags", + "pattern": "<[^>]*>", + "description": "Reference: https://stackoverflow.com/questions/11229831/regular-expression-to-remove-html-tags-from-a-string" + } + ], + "ignoreRegExpList": [ + "Markdown links", + "Markdown code blocks", + "Inline code blocks", + "Link contents", + "Snippet references", + "Snippet references 2", + "Multi-line code blocks", + "HTML Tags" ], - "patterns": [ - { - "name": "Markdown links", - "pattern": "\\((.*)\\)", - "description": "" - }, - { - "name": "Markdown code blocks", - "pattern": "/^(\\s*`{3,}).*[\\s\\S]*?^\\1/gmx", - "description": "Taken from the cSpell example at https://cspell.org/configuration/patterns/#verbose-regular-expressions" - }, - { - "name": "Inline code blocks", - "pattern": "\\`([^\\`\\r\\n]+?)\\`", - "description": "https://stackoverflow.com/questions/41274241/how-to-capture-inline-markdown-code-but-not-a-markdown-code-fence-with-regex" - }, - { - "name": "Link contents", - "pattern": "\\<a(.*)\\>", - "description": "" - }, - { - "name": "Snippet references", - "pattern": "-- snippet:(.*)", - "description": "" - }, - { - "name": "Snippet references 2", - "pattern": "\\<\\[sample:(.*)", - "description": "another kind of snippet reference" - }, - { - "name": "Multi-line code blocks", - "pattern": "/^\\s*```[\\s\\S]*?^\\s*```/gm" - }, - { - "name": "HTML Tags", - "pattern": "<[^>]*>", - "description": "Reference: https://stackoverflow.com/questions/11229831/regular-expression-to-remove-html-tags-from-a-string" - } - ], - "ignoreRegExpList": [ - "Markdown links", - "Markdown code blocks", - "Inline code blocks", - "Link contents", - "Snippet references", - "Snippet references 2", - "Multi-line code blocks", - "HTML Tags" - ], "ignorePaths": [ "packages/mermaid/src/docs/CHANGELOG.md" ] From 44f463c4f490c10616c7c207a75d60f1f3860490 Mon Sep 17 00:00:00 2001 From: Sean Killeen <SeanKilleen@gmail.com> Date: Fri, 7 Oct 2022 21:42:39 -0400 Subject: [PATCH 40/44] format docs YAML --- .github/workflows/docs.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5cd3d65f48..e308ac886b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -5,15 +5,15 @@ on: branches: - develop paths: - - "packages/mermaid/src/docs/**/*" + - 'packages/mermaid/src/docs/**/*' pull_request: branches: - develop paths: - - "packages/mermaid/src/docs/**/*" + - 'packages/mermaid/src/docs/**/*' jobs: spellcheck: - name: "Docs: Spellcheck" + name: 'Docs: Spellcheck' runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 @@ -21,7 +21,7 @@ jobs: - uses: actions/setup-node@v1 name: Setup node with: - node-version: "16" + node-version: '16' - run: npm install -g cspell name: Install cSpell - run: cspell --config ./cSpell.json "packages/mermaid/src/docs/**/*.md" --no-progress From 7e1006db26a4c7bbf991aa8b43e81c5642842d23 Mon Sep 17 00:00:00 2001 From: Sean Killeen <SeanKilleen@gmail.com> Date: Fri, 7 Oct 2022 21:54:40 -0400 Subject: [PATCH 41/44] format cSpell.json --- cSpell.json | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/cSpell.json b/cSpell.json index 55b362daf1..5abf6e2838 100644 --- a/cSpell.json +++ b/cSpell.json @@ -91,7 +91,5 @@ "Multi-line code blocks", "HTML Tags" ], - "ignorePaths": [ - "packages/mermaid/src/docs/CHANGELOG.md" - ] + "ignorePaths": ["packages/mermaid/src/docs/CHANGELOG.md"] } From 2b40bc0a4829ba7e93fd4b32f49a195e8b20eb81 Mon Sep 17 00:00:00 2001 From: Sean Killeen <SeanKilleen@gmail.com> Date: Fri, 7 Oct 2022 21:56:28 -0400 Subject: [PATCH 42/44] format Setup.md --- packages/mermaid/src/docs/Setup.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/mermaid/src/docs/Setup.md b/packages/mermaid/src/docs/Setup.md index 90e9edc915..0c8f50bb80 100644 --- a/packages/mermaid/src/docs/Setup.md +++ b/packages/mermaid/src/docs/Setup.md @@ -735,8 +735,8 @@ Default value: true ## defaultRenderer -| Parameter | Description | Type | Required | Values | -| --------------- | ----------- | ------- | -------- | ----------------------- | +| Parameter | Description | Type | Required | Values | +| --------------- | ----------- | ------- | -------- | --------------------------- | | defaultRenderer | See notes | boolean | 4 | `dagre-d3`, `dagre-wrapper` | **Notes**: @@ -761,8 +761,8 @@ Default value: true ## defaultRenderer -| Parameter | Description | Type | Required | Values | -| --------------- | ----------- | ------- | -------- | ----------------------- | +| Parameter | Description | Type | Required | Values | +| --------------- | ----------- | ------- | -------- | --------------------------- | | defaultRenderer | See notes | boolean | 4 | `dagre-d3`, `dagre-wrapper` | **Notes:** From e21da2ec7f4fbebd20fac95ac99c67d69887478f Mon Sep 17 00:00:00 2001 From: Sean Killeen <SeanKilleen@gmail.com> Date: Fri, 7 Oct 2022 21:58:52 -0400 Subject: [PATCH 43/44] capitalization fix --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e308ac886b..1e08a5c16b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -25,4 +25,4 @@ jobs: - run: npm install -g cspell name: Install cSpell - run: cspell --config ./cSpell.json "packages/mermaid/src/docs/**/*.md" --no-progress - name: run cSpell + name: Run cSpell From a23a7edd26de5f83c08c9b6324ac17eb20be1f42 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod <sidharthv96@gmail.com> Date: Sat, 8 Oct 2022 12:17:26 +0800 Subject: [PATCH 44/44] docs: Sync --- docs/README.md | 4 ++-- docs/Setup.md | 46 +++++++++++++++++++++---------------------- docs/accessibility.md | 2 +- docs/c4c.md | 2 +- docs/integrations.md | 2 +- docs/mindmap.md | 4 ++-- 6 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/README.md b/docs/README.md index 00e03c76d1..62f5b9d9b5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -347,7 +347,7 @@ Update version number in `package.json`. npm publish ``` -The above command generates files into the `dist` folder and publishes them to npmjs.org. +The above command generates files into the `dist` folder and publishes them to \<npmjs.org>. ## Related projects @@ -363,7 +363,7 @@ Detailed information about how to contribute can be found in the [contribution g ## Security and safe diagrams -For public sites, it can be precarious to retrieve text from users on the internet, storing that content for presentation in a browser at a later stage. The reason is that the user content can contain embedded malicious scripts that will run when the data is presented. For Mermaid this is a risk, specially as mermaid diagrams contain many characters that are used in html which makes the standard sanitation unusable as it also breaks the diagrams. We still make an effort to sanitise the incoming code and keep refining the process but it is hard to guarantee that there are no loop holes. +For public sites, it can be precarious to retrieve text from users on the internet, storing that content for presentation in a browser at a later stage. The reason is that the user content can contain embedded malicious scripts that will run when the data is presented. For Mermaid this is a risk, specially as mermaid diagrams contain many characters that are used in html which makes the standard sanitation unusable as it also breaks the diagrams. We still make an effort to sanitize the incoming code and keep refining the process but it is hard to guarantee that there are no loop holes. As an extra level of security for sites with external users we are happy to introduce a new security level in which the diagram is rendered in a sandboxed iframe preventing JavaScript in the code from being executed. This is a great step forward for better security. diff --git a/docs/Setup.md b/docs/Setup.md index 89a3e91460..dec5134989 100644 --- a/docs/Setup.md +++ b/docs/Setup.md @@ -74,15 +74,15 @@ Theme , the CSS style sheet | Parameter | Description | Type | Required | Values | | ------------- | --------------------------------- | ------ | -------- | ------------------------------------------ | -| securityLevel | Level of trust for parsed diagram | string | Required | 'sandbox', 'strict', 'loose', 'antiscript' | +| securityLevel | Level of trust for parsed diagram | string | Required | `sandbox`, `strict`, `loose`, `antiscript` | **Notes**: -- **strict**: (**default**) tags in text are encoded, click functionality is disabled -- **loose**: tags in text are allowed, click functionality is enabled -- **antiscript**: html tags in text are allowed, (only script element is removed), click +- **`strict`**: (**default**) tags in text are encoded, click functionality is disabled +- **`loose`**: tags in text are allowed, click functionality is enabled +- **`antiscript`**: html tags in text are allowed, (only script element is removed), click functionality is enabled -- **sandbox**: With this security level all rendering takes place in a sandboxed iframe. This +- **`sandbox`**: With this security level all rendering takes place in a sandboxed iframe. This prevent any JavaScript from running in the context. This may hinder interactive functionality of the diagram like scripts, popups in sequence diagram or links to other tabs/targets etc. @@ -121,11 +121,11 @@ Default value: \['secure', 'securityLevel', 'startOnLoad', 'maxTextSize'] This option controls if the generated ids of nodes in the SVG are generated randomly or based on a seed. If set to false, the IDs are generated based on the current date and thus are not -deterministic. This is the default behaviour. +deterministic. This is the default behavior. **Notes**: -This matters if your files are checked into sourcecontrol e.g. git and should not change unless +This matters if your files are checked into source control e.g. git and should not change unless content is changed. Default value: false @@ -212,16 +212,16 @@ Default value: true ### defaultRenderer -| Parameter | Description | Type | Required | Values | -| --------------- | ----------- | ------- | -------- | ----------------------- | -| defaultRenderer | See notes | boolean | 4 | dagre-d3, dagre-wrapper | +| Parameter | Description | Type | Required | Values | +| --------------- | ----------- | ------- | -------- | --------------------------- | +| defaultRenderer | See notes | boolean | 4 | `dagre-d3`, `dagre-wrapper` | **Notes:** Decides which rendering engine that is to be used for the rendering. Legal values are: -dagre-d3 dagre-wrapper - wrapper for dagre implemented in mermaid +`dagre-d3` `dagre-wrapper` - wrapper for `dagre` implemented in mermaid -Default value: 'dagre-wrapper' +Default value: `dagre-wrapper` ## sequence @@ -737,16 +737,16 @@ Default value: true ## defaultRenderer -| Parameter | Description | Type | Required | Values | -| --------------- | ----------- | ------- | -------- | ----------------------- | -| defaultRenderer | See notes | boolean | 4 | dagre-d3, dagre-wrapper | +| Parameter | Description | Type | Required | Values | +| --------------- | ----------- | ------- | -------- | --------------------------- | +| defaultRenderer | See notes | boolean | 4 | `dagre-d3`, `dagre-wrapper` | **Notes**: Decides which rendering engine that is to be used for the rendering. Legal values are: -dagre-d3 dagre-wrapper - wrapper for dagre implemented in mermaid +`dagre-d3` `dagre-wrapper` - wrapper for `dagre` implemented in mermaid -Default value: 'dagre-d3' +Default value: `dagre-d3` ## useMaxWidth @@ -763,16 +763,16 @@ Default value: true ## defaultRenderer -| Parameter | Description | Type | Required | Values | -| --------------- | ----------- | ------- | -------- | ----------------------- | -| defaultRenderer | See notes | boolean | 4 | dagre-d3, dagre-wrapper | +| Parameter | Description | Type | Required | Values | +| --------------- | ----------- | ------- | -------- | --------------------------- | +| defaultRenderer | See notes | boolean | 4 | `dagre-d3`, `dagre-wrapper` | **Notes:** Decides which rendering engine that is to be used for the rendering. Legal values are: -dagre-d3 dagre-wrapper - wrapper for dagre implemented in mermaid +`dagre-d3` `dagre-wrapper` - wrapper for `dagre` implemented in mermaid -Default value: 'dagre-d3' +Default value: `dagre-d3` ## er @@ -994,7 +994,7 @@ Default value: 4 | --------------- | ----------- | ------- | -------- | ------------------ | | c4BoundaryInRow | See Notes | Integer | Required | Any Positive Value | -**Notes:** How many boundarys to place in each row. +**Notes:** How many boundaries to place in each row. Default value: 2 diff --git a/docs/accessibility.md b/docs/accessibility.md index bce3da25d7..09d80df652 100644 --- a/docs/accessibility.md +++ b/docs/accessibility.md @@ -19,7 +19,7 @@ The diagram authors can now add the accessibility options in the diagram definit - `accTitle: "Your Accessibility Title"` or - `accDescr: "Your Accessibility Description"` -**When these two options are defined, they will add a coressponding `<title>` and `<desc>` tag in the SVG.** +**When these two options are defined, they will add a corresponding `<title>` and `<desc>` tag in the SVG.** Let us take a look at the following example with a flowchart diagram: diff --git a/docs/c4c.md b/docs/c4c.md index 40dbb6fe6c..4f9e09ab5e 100644 --- a/docs/c4c.md +++ b/docs/c4c.md @@ -220,7 +220,7 @@ The following unfinished features are not supported in the short term. - - \[x] RelIndex \* Compatible with C4-Plantuml syntax, but ignores the index parameter. The sequence number is determined by the order in which the rel statements are written. -- \[ ] Custom tags/stereotypes support and skinparam updates +- \[ ] Custom tags/stereotypes support and skin param updates - - \[ ] AddElementTag(tagStereo, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new element tag. The styles of the tagged elements are updated and the tag is displayed in the calculated legend. diff --git a/docs/integrations.md b/docs/integrations.md index 49c1034922..09df7cf9fe 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -33,7 +33,7 @@ They also serve as proof of concept, for the variety of things that can be built - [Mermaid Macro](https://www.redmine.org/plugins/redmine_mermaid_macro) - [redmine-mermaid](https://github.com/styz/redmine_mermaid) - [markdown-for-mermaid-plugin](https://github.com/jamieh-mongolian/markdown-for-mermaid-plugin) -- [Jetsbrain IDE eg Pycharm](https://www.jetbrains.com/go/guide/tips/mermaid-js-support-in-markdown/) +- [JetBrains IDE eg Pycharm](https://www.jetbrains.com/go/guide/tips/mermaid-js-support-in-markdown/) - [mermerd](https://github.com/KarnerTh/mermerd) ## CRM/ERP/Similar diff --git a/docs/mindmap.md b/docs/mindmap.md index f56a2186d6..94baf43e01 100644 --- a/docs/mindmap.md +++ b/docs/mindmap.md @@ -2,7 +2,7 @@ # Mindmap -> Mindmap: This is an experimental diagram for now. The syntax and properties can change in future releases. The syntax is stabel except for the icon integration which is the experimental part. +> Mindmap: This is an experimental diagram for now. The syntax and properties can change in future releases. The syntax is stable except for the icon integration which is the experimental part. "A mind map is a diagram used to visually organize information into a hierarchy, showing relationships among pieces of the whole. It is often created around a single concept, drawn as an image in the center of a blank page, to which associated representations of ideas such as images, words and parts of words are added. Major ideas are connected directly to the central concept, and other ideas branch out from those major ideas." Wikipedia @@ -54,7 +54,7 @@ mindmap The syntax for creating Mindmaps is simple and relies on indentation for setting the levels in the hierarchy. -In the following example you can see how there are 3 dufferent levels. One with starting at the left of the text and another level with two rows starting at the same column, defining the node A. At the end there is one more level where the text is indented further then the prevoius lines defining the nodes B and C. +In the following example you can see how there are 3 different levels. One with starting at the left of the text and another level with two rows starting at the same column, defining the node A. At the end there is one more level where the text is indented further then the previous lines defining the nodes B and C. mindmap Root