From d05e53366c098ccda46b85cc903184015debabd9 Mon Sep 17 00:00:00 2001 From: Romain Vasseur <57908971+RVR06@users.noreply.github.com> Date: Wed, 19 Jun 2024 19:16:58 +0200 Subject: [PATCH] Switch to page bundle --- README.md | 16 ++++++++-------- docs/content/docs/c4/_index.md | 12 ++++++------ .../docs/c4}/structurizr-1-C4-1.svg | 0 .../docs/c4}/structurizr-1-C4-2.svg | 0 .../docs/c4}/structurizr-1-C4-3.svg | 0 .../docs/c4}/structurizr-1-C4-L.svg | 0 .../docs/c4}/structurizr-1-WSL.png | Bin .../docs/c4}/structurizr-1-Windows.png | Bin .../docs/features/breadcrumb}/breadcrumb.png | Bin .../{breadcrumb.md => breadcrumb/index.md} | 2 +- .../docs/features/format}/format.gif | Bin .../features/{format.md => format/index.md} | 2 +- .../features/highlighting}/highlighting.gif | Bin .../{highlighting.md => highlighting/index.md} | 2 +- .../docs/features/hover}/hover.png | Bin .../docs/features/{hover.md => hover/index.md} | 2 +- .../{intellisense.md => intellisense/index.md} | 2 +- .../features/intellisense/intellisense.gif} | Bin .../features/{preview.md => preview/index.md} | 2 +- .../docs/features/preview}/preview.png | Bin .../features/{semantic.md => semantic/index.md} | 2 +- .../docs/features/semantic}/semantic.gif | Bin .../{transpiler.md => transpiler/index.md} | 6 ++---- .../docs/features/transpiler}/transpiler.png | Bin .../docs/features/transpiler}/transpiler_02.png | Bin 25 files changed, 23 insertions(+), 25 deletions(-) rename docs/{static/assets/archi => content/docs/c4}/structurizr-1-C4-1.svg (100%) rename docs/{static/assets/archi => content/docs/c4}/structurizr-1-C4-2.svg (100%) rename docs/{static/assets/archi => content/docs/c4}/structurizr-1-C4-3.svg (100%) rename docs/{static/assets/archi => content/docs/c4}/structurizr-1-C4-L.svg (100%) rename docs/{static/assets/archi => content/docs/c4}/structurizr-1-WSL.png (100%) rename docs/{static/assets/archi => content/docs/c4}/structurizr-1-Windows.png (100%) rename docs/{static/assets => content/docs/features/breadcrumb}/breadcrumb.png (100%) rename docs/content/docs/features/{breadcrumb.md => breadcrumb/index.md} (94%) rename docs/{static/assets => content/docs/features/format}/format.gif (100%) rename docs/content/docs/features/{format.md => format/index.md} (87%) rename docs/{static/assets => content/docs/features/highlighting}/highlighting.gif (100%) rename docs/content/docs/features/{highlighting.md => highlighting/index.md} (94%) rename docs/{static/assets => content/docs/features/hover}/hover.png (100%) rename docs/content/docs/features/{hover.md => hover/index.md} (94%) rename docs/content/docs/features/{intellisense.md => intellisense/index.md} (93%) rename docs/{static/assets/completion.gif => content/docs/features/intellisense/intellisense.gif} (100%) rename docs/content/docs/features/{preview.md => preview/index.md} (94%) rename docs/{static/assets => content/docs/features/preview}/preview.png (100%) rename docs/content/docs/features/{semantic.md => semantic/index.md} (91%) rename docs/{static/assets => content/docs/features/semantic}/semantic.gif (100%) rename docs/content/docs/features/{transpiler.md => transpiler/index.md} (94%) rename docs/{static/assets => content/docs/features/transpiler}/transpiler.png (100%) rename docs/{static/assets => content/docs/features/transpiler}/transpiler_02.png (100%) diff --git a/README.md b/README.md index bf85e8c..be5c96d 100644 --- a/README.md +++ b/README.md @@ -25,42 +25,42 @@ Then, within VSCode, open the `Extensions` view, select for `Install from VSIX` format + src="https://rvr06.github.io/cornifer/docs/features/format/format.gif" /> ### Syntax highlighting highlighting + src="https://rvr06.github.io/cornifer/docs/features/highlighting/highlighting.gif" /> ### Semantic highlighting semantic + src="https://rvr06.github.io/cornifer/docs/features/semantic/semantic.gif" /> ### Code completion completion + src="https://rvr06.github.io/cornifer/docs/features/intellisense/intellisense.gif" /> ### Hover hover + src="https://rvr06.github.io/cornifer/docs/features/hover/hover.png" /> ### Live preview preview + src="https://rvr06.github.io/cornifer/docs/features/preview/preview.png" /> ### Outline preview -![outline](https://rvr06.github.io/cornifer/assets/breadcrumb.png) +![outline](https://rvr06.github.io/cornifer/docs/features/breadcrumb/breadcrumb.png) ### Docker compose transpiler -![transpiler](https://rvr06.github.io/cornifer/assets/transpiler.png) +![transpiler](https://rvr06.github.io/cornifer/docs/features/transpiler/transpiler.png) diff --git a/docs/content/docs/c4/_index.md b/docs/content/docs/c4/_index.md index 57e1de7..c88e085 100644 --- a/docs/content/docs/c4/_index.md +++ b/docs/content/docs/c4/_index.md @@ -11,26 +11,26 @@ date: 2023-09-21 ## C4.L -![](/assets/archi/structurizr-1-C4-L.svg) +![](structurizr-1-C4-L.svg) ## C4.1 -![](/assets/archi/structurizr-1-C4-1.svg) +![](structurizr-1-C4-1.svg) ## C4.2 -![](/assets/archi/structurizr-1-C4-2.svg) +![](structurizr-1-C4-2.svg) ## C4.3 -![](/assets/archi/structurizr-1-C4-3.svg) +![](structurizr-1-C4-3.svg) ## C4.D ### Windows -![](/assets/archi/structurizr-1-Windows.png) +![](structurizr-1-Windows.png) ### WSL2 -![](/assets/archi/structurizr-1-WSL.png) \ No newline at end of file +![](structurizr-1-WSL.png) \ No newline at end of file diff --git a/docs/static/assets/archi/structurizr-1-C4-1.svg b/docs/content/docs/c4/structurizr-1-C4-1.svg similarity index 100% rename from docs/static/assets/archi/structurizr-1-C4-1.svg rename to docs/content/docs/c4/structurizr-1-C4-1.svg diff --git a/docs/static/assets/archi/structurizr-1-C4-2.svg b/docs/content/docs/c4/structurizr-1-C4-2.svg similarity index 100% rename from docs/static/assets/archi/structurizr-1-C4-2.svg rename to docs/content/docs/c4/structurizr-1-C4-2.svg diff --git a/docs/static/assets/archi/structurizr-1-C4-3.svg b/docs/content/docs/c4/structurizr-1-C4-3.svg similarity index 100% rename from docs/static/assets/archi/structurizr-1-C4-3.svg rename to docs/content/docs/c4/structurizr-1-C4-3.svg diff --git a/docs/static/assets/archi/structurizr-1-C4-L.svg b/docs/content/docs/c4/structurizr-1-C4-L.svg similarity index 100% rename from docs/static/assets/archi/structurizr-1-C4-L.svg rename to docs/content/docs/c4/structurizr-1-C4-L.svg diff --git a/docs/static/assets/archi/structurizr-1-WSL.png b/docs/content/docs/c4/structurizr-1-WSL.png similarity index 100% rename from docs/static/assets/archi/structurizr-1-WSL.png rename to docs/content/docs/c4/structurizr-1-WSL.png diff --git a/docs/static/assets/archi/structurizr-1-Windows.png b/docs/content/docs/c4/structurizr-1-Windows.png similarity index 100% rename from docs/static/assets/archi/structurizr-1-Windows.png rename to docs/content/docs/c4/structurizr-1-Windows.png diff --git a/docs/static/assets/breadcrumb.png b/docs/content/docs/features/breadcrumb/breadcrumb.png similarity index 100% rename from docs/static/assets/breadcrumb.png rename to docs/content/docs/features/breadcrumb/breadcrumb.png diff --git a/docs/content/docs/features/breadcrumb.md b/docs/content/docs/features/breadcrumb/index.md similarity index 94% rename from docs/content/docs/features/breadcrumb.md rename to docs/content/docs/features/breadcrumb/index.md index 2530b7d..6b0d841 100644 --- a/docs/content/docs/features/breadcrumb.md +++ b/docs/content/docs/features/breadcrumb/index.md @@ -8,4 +8,4 @@ date: 2022-03-13 Even if there are some ways to mitigate its expansion, such as leveraging `extends` or `include` facilities, `C4 DSL` workspace is likely to grow over time. To ensure users can efficiently work within sizable workspace, `Cornifer` is able to surface symbols from the `C4 DSL` syntax to support VS Code navigation paradigm through outline and breadcrumb views. Thus, you gain both a schematic overview of the underlying model and a one-click navigation facility. -![](/assets/breadcrumb.png) \ No newline at end of file +![](breadcrumb.png) \ No newline at end of file diff --git a/docs/static/assets/format.gif b/docs/content/docs/features/format/format.gif similarity index 100% rename from docs/static/assets/format.gif rename to docs/content/docs/features/format/format.gif diff --git a/docs/content/docs/features/format.md b/docs/content/docs/features/format/index.md similarity index 87% rename from docs/content/docs/features/format.md rename to docs/content/docs/features/format/index.md index 8c177d6..5d58c5e 100644 --- a/docs/content/docs/features/format.md +++ b/docs/content/docs/features/format/index.md @@ -8,4 +8,4 @@ date: 2022-01-15 `Cornifer` comes with a built-in formatting capability, activated on-demand and on-save. -![](/assets/format.gif) \ No newline at end of file +![](format.gif) \ No newline at end of file diff --git a/docs/static/assets/highlighting.gif b/docs/content/docs/features/highlighting/highlighting.gif similarity index 100% rename from docs/static/assets/highlighting.gif rename to docs/content/docs/features/highlighting/highlighting.gif diff --git a/docs/content/docs/features/highlighting.md b/docs/content/docs/features/highlighting/index.md similarity index 94% rename from docs/content/docs/features/highlighting.md rename to docs/content/docs/features/highlighting/index.md index 88764a2..1f27b75 100644 --- a/docs/content/docs/features/highlighting.md +++ b/docs/content/docs/features/highlighting/index.md @@ -10,4 +10,4 @@ date: 2022-01-03 At the time of writing, language server has not been implemented yet, preventing extension to provide error checks. In the meanwhile, a tacit workaround is to assume that if you read/write a line w/o any colors, this line is wrong ie conflicts with the underlying grammar (either misspelled or wrongly placed). [Hover](#hover) facility is at the rescue to provide guidance. -![](/assets/highlighting.gif) \ No newline at end of file +![](highlighting.gif) \ No newline at end of file diff --git a/docs/static/assets/hover.png b/docs/content/docs/features/hover/hover.png similarity index 100% rename from docs/static/assets/hover.png rename to docs/content/docs/features/hover/hover.png diff --git a/docs/content/docs/features/hover.md b/docs/content/docs/features/hover/index.md similarity index 94% rename from docs/content/docs/features/hover.md rename to docs/content/docs/features/hover/index.md index 8604327..3ecf575 100644 --- a/docs/content/docs/features/hover.md +++ b/docs/content/docs/features/hover/index.md @@ -10,4 +10,4 @@ Most of the C4 DSL keywords can be hovered over to gain insights, such as semant As explained, due to lack of language server, it is the only built-in way to check document compliance. When in doubt, fallback to the [official documentation](https://github.com/structurizr/dsl/blob/master/docs/language-reference.md). -![](/assets/hover.png) \ No newline at end of file +![](hover.png) \ No newline at end of file diff --git a/docs/content/docs/features/intellisense.md b/docs/content/docs/features/intellisense/index.md similarity index 93% rename from docs/content/docs/features/intellisense.md rename to docs/content/docs/features/intellisense/index.md index 3000319..4b67ad5 100644 --- a/docs/content/docs/features/intellisense.md +++ b/docs/content/docs/features/intellisense/index.md @@ -12,4 +12,4 @@ Code snippets and code completion serve two purposes: gently supporting newcomer Once again, without language server, code completion is not contextual for the moment, but it will soon be. -![](/assets/completion.gif) \ No newline at end of file +![](completion.gif) \ No newline at end of file diff --git a/docs/static/assets/completion.gif b/docs/content/docs/features/intellisense/intellisense.gif similarity index 100% rename from docs/static/assets/completion.gif rename to docs/content/docs/features/intellisense/intellisense.gif diff --git a/docs/content/docs/features/preview.md b/docs/content/docs/features/preview/index.md similarity index 94% rename from docs/content/docs/features/preview.md rename to docs/content/docs/features/preview/index.md index 0b6d206..87a5b9c 100644 --- a/docs/content/docs/features/preview.md +++ b/docs/content/docs/features/preview/index.md @@ -13,4 +13,4 @@ You are now ready to enter the Edit-Save-Refresh cycle to craft your model. Structurizr session is provisioned when you hit the preview button, and decommissioned when the workspace.dsl is closed. -![](/assets/preview.png) \ No newline at end of file +![](preview.png) \ No newline at end of file diff --git a/docs/static/assets/preview.png b/docs/content/docs/features/preview/preview.png similarity index 100% rename from docs/static/assets/preview.png rename to docs/content/docs/features/preview/preview.png diff --git a/docs/content/docs/features/semantic.md b/docs/content/docs/features/semantic/index.md similarity index 91% rename from docs/content/docs/features/semantic.md rename to docs/content/docs/features/semantic/index.md index 1d7914b..4fe3ebb 100644 --- a/docs/content/docs/features/semantic.md +++ b/docs/content/docs/features/semantic/index.md @@ -10,4 +10,4 @@ date: 2022-02-03 Once again, no proper error checks. In the meanwhile, one could easily spot error by monitoring color - or more accurately, lack of. -![](/assets/semantic.gif) +![](semantic.gif) diff --git a/docs/static/assets/semantic.gif b/docs/content/docs/features/semantic/semantic.gif similarity index 100% rename from docs/static/assets/semantic.gif rename to docs/content/docs/features/semantic/semantic.gif diff --git a/docs/content/docs/features/transpiler.md b/docs/content/docs/features/transpiler/index.md similarity index 94% rename from docs/content/docs/features/transpiler.md rename to docs/content/docs/features/transpiler/index.md index 0bfc9cf..b823047 100644 --- a/docs/content/docs/features/transpiler.md +++ b/docs/content/docs/features/transpiler/index.md @@ -16,7 +16,7 @@ Being able to efficiently communicate with devops team is key. To do so, one may Here comes `Cornifer` and its last `transpiler` feature! -![](/assets/transpiler.png) +![](transpiler.png) --- @@ -85,6 +85,4 @@ workspace "compose" "Auto-generated from compose.yaml" { ## **Then** user is able to visualize diagram through `Structurizr` -![](/assets/transpiler_02.png) - -![alt text](image.png) \ No newline at end of file +![](transpiler_02.png) \ No newline at end of file diff --git a/docs/static/assets/transpiler.png b/docs/content/docs/features/transpiler/transpiler.png similarity index 100% rename from docs/static/assets/transpiler.png rename to docs/content/docs/features/transpiler/transpiler.png diff --git a/docs/static/assets/transpiler_02.png b/docs/content/docs/features/transpiler/transpiler_02.png similarity index 100% rename from docs/static/assets/transpiler_02.png rename to docs/content/docs/features/transpiler/transpiler_02.png