From 60cf043c3d2c10a7f0bc048272a4fa3e36cc17b6 Mon Sep 17 00:00:00 2001 From: Brian Graham <379322+Incognito@users.noreply.github.com> Date: Sun, 23 Jul 2023 08:27:54 +0200 Subject: [PATCH 1/2] Corrects name of C4 link --- packages/mermaid/src/docs/.vitepress/config.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/.vitepress/config.ts b/packages/mermaid/src/docs/.vitepress/config.ts index 8fceb810be..054b57ae39 100644 --- a/packages/mermaid/src/docs/.vitepress/config.ts +++ b/packages/mermaid/src/docs/.vitepress/config.ts @@ -134,7 +134,7 @@ function sidebarSyntax() { { text: 'Quadrant Chart', link: '/syntax/quadrantChart' }, { text: 'Requirement Diagram', link: '/syntax/requirementDiagram' }, { text: 'Gitgraph (Git) Diagram 🔥', link: '/syntax/gitgraph' }, - { text: 'C4C Diagram (Context) Diagram 🦺⚠️', link: '/syntax/c4c' }, + { text: 'C4 Diagram 🦺⚠️', link: '/syntax/c4c' }, { text: 'Mindmaps 🔥', link: '/syntax/mindmap' }, { text: 'Timeline 🔥', link: '/syntax/timeline' }, { text: 'Zenuml 🔥', link: '/syntax/zenuml' }, From 27d98728a6ff25797528c504bf1e71572969fe2a Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Tue, 25 Jul 2023 17:42:12 +0530 Subject: [PATCH 2/2] chore: Rename C4C to C4 --- docs/syntax/{c4c.md => c4.md} | 6 +++--- packages/mermaid/src/docs/.vitepress/config.ts | 2 +- packages/mermaid/src/docs/.vitepress/theme/redirect.ts | 3 ++- packages/mermaid/src/docs/syntax/{c4c.md => c4.md} | 4 ++-- 4 files changed, 8 insertions(+), 7 deletions(-) rename docs/syntax/{c4c.md => c4.md} (99%) rename packages/mermaid/src/docs/syntax/{c4c.md => c4.md} (99%) diff --git a/docs/syntax/c4c.md b/docs/syntax/c4.md similarity index 99% rename from docs/syntax/c4c.md rename to docs/syntax/c4.md index dd5fa21b0d..5c89671681 100644 --- a/docs/syntax/c4c.md +++ b/docs/syntax/c4.md @@ -2,13 +2,13 @@ > > ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. > -> ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/c4c.md](../../packages/mermaid/src/docs/syntax/c4c.md). +> ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/c4.md](../../packages/mermaid/src/docs/syntax/c4.md). # C4 Diagrams > C4 Diagram: This is an experimental diagram for now. The syntax and properties can change in future releases. Proper documentation will be provided when the syntax is stable. -Mermaid's c4 diagram syntax is compatible with plantUML. See example below: +Mermaid's C4 diagram syntax is compatible with plantUML. See example below: ```mermaid-example C4Context @@ -114,7 +114,7 @@ For an example, see the source code demos/index.html - Dynamic diagram (C4Dynamic) - Deployment diagram (C4Deployment) -Please refer to the linked document [C4-PlantUML syntax](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md) for how to write the c4 diagram. +Please refer to the linked document [C4-PlantUML syntax](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md) for how to write the C4 diagram. C4 diagram is fixed style, such as css color, so different css is not provided under different skins. updateElementStyle and UpdateElementStyle are written in the diagram last part. updateElementStyle is inconsistent with the original definition and updates the style of the relationship, including the offset of the text label relative to the original position. diff --git a/packages/mermaid/src/docs/.vitepress/config.ts b/packages/mermaid/src/docs/.vitepress/config.ts index 054b57ae39..b7b9529504 100644 --- a/packages/mermaid/src/docs/.vitepress/config.ts +++ b/packages/mermaid/src/docs/.vitepress/config.ts @@ -134,7 +134,7 @@ function sidebarSyntax() { { text: 'Quadrant Chart', link: '/syntax/quadrantChart' }, { text: 'Requirement Diagram', link: '/syntax/requirementDiagram' }, { text: 'Gitgraph (Git) Diagram 🔥', link: '/syntax/gitgraph' }, - { text: 'C4 Diagram 🦺⚠️', link: '/syntax/c4c' }, + { text: 'C4 Diagram 🦺⚠️', link: '/syntax/c4' }, { text: 'Mindmaps 🔥', link: '/syntax/mindmap' }, { text: 'Timeline 🔥', link: '/syntax/timeline' }, { text: 'Zenuml 🔥', link: '/syntax/zenuml' }, diff --git a/packages/mermaid/src/docs/.vitepress/theme/redirect.ts b/packages/mermaid/src/docs/.vitepress/theme/redirect.ts index 936d6f7e29..24b9a4d1f8 100644 --- a/packages/mermaid/src/docs/.vitepress/theme/redirect.ts +++ b/packages/mermaid/src/docs/.vitepress/theme/redirect.ts @@ -28,7 +28,7 @@ const idRedirectMap: Record = { '8.6.0_docs': '', accessibility: 'config/theming', breakingchanges: '', - c4c: 'syntax/c4c', + c4c: 'syntax/c4', classdiagram: 'syntax/classDiagram', configuration: 'config/configuration', demos: 'ecosystem/integrations', @@ -70,6 +70,7 @@ const idRedirectMap: Record = { const urlRedirectMap: Record = { '/misc/faq.html': 'configure/faq.html', + '/syntax/c4c.html': 'syntax/c4.html', }; /** diff --git a/packages/mermaid/src/docs/syntax/c4c.md b/packages/mermaid/src/docs/syntax/c4.md similarity index 99% rename from packages/mermaid/src/docs/syntax/c4c.md rename to packages/mermaid/src/docs/syntax/c4.md index 78528f7b99..489b423c03 100644 --- a/packages/mermaid/src/docs/syntax/c4c.md +++ b/packages/mermaid/src/docs/syntax/c4.md @@ -2,7 +2,7 @@ > C4 Diagram: This is an experimental diagram for now. The syntax and properties can change in future releases. Proper documentation will be provided when the syntax is stable. -Mermaid's c4 diagram syntax is compatible with plantUML. See example below: +Mermaid's C4 diagram syntax is compatible with plantUML. See example below: ```mermaid-example C4Context @@ -61,7 +61,7 @@ For an example, see the source code demos/index.html - Dynamic diagram (C4Dynamic) - Deployment diagram (C4Deployment) -Please refer to the linked document [C4-PlantUML syntax](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md) for how to write the c4 diagram. +Please refer to the linked document [C4-PlantUML syntax](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md) for how to write the C4 diagram. C4 diagram is fixed style, such as css color, so different css is not provided under different skins. updateElementStyle and UpdateElementStyle are written in the diagram last part. updateElementStyle is inconsistent with the original definition and updates the style of the relationship, including the offset of the text label relative to the original position.