Skip to content

Commit

Permalink
Fix HUGO (#3)
Browse files Browse the repository at this point in the history
* Bump actions and use baseURL

* Switch to page bundle
  • Loading branch information
RVR06 authored Jun 19, 2024
1 parent 325f832 commit 7e1fe22
Show file tree
Hide file tree
Showing 26 changed files with 32 additions and 31 deletions.
15 changes: 9 additions & 6 deletions .github/workflows/gh-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,14 @@ jobs:
run:
working-directory: ${{ env.documentation_root }}
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0
submodules: recursive
lfs: 'true'

- name: Setup Pages
id: pages
uses: actions/configure-pages@v4

- name: Setup Node
uses: actions/setup-node@v3
Expand All @@ -47,16 +50,16 @@ jobs:
run: npm ci

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2.6.0
uses: peaceiris/actions-hugo@v3
with:
hugo-version: 0.123.8
extended: true

- name: Build
run: hugo --minify
run: hugo --minify --baseURL "${{ steps.pages.outputs.base_url }}/"

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
uses: actions/upload-pages-artifact@v3
with:
path: ${{ env.documentation_root }}/public

Expand All @@ -83,4 +86,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
uses: actions/deploy-pages@v4
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,42 +25,42 @@ Then, within VSCode, open the `Extensions` view, select for `Install from VSIX`

<img
alt="format"
src="https://rvr06.github.io/cornifer/assets/format.gif" />
src="https://rvr06.github.io/cornifer/docs/features/format/format.gif" />

### Syntax highlighting

<img
alt="highlighting"
src="https://rvr06.github.io/cornifer/assets/highlighting.gif" />
src="https://rvr06.github.io/cornifer/docs/features/highlighting/highlighting.gif" />

### Semantic highlighting

<img
alt="semantic"
src="https://rvr06.github.io/cornifer/assets/semantic.gif" />
src="https://rvr06.github.io/cornifer/docs/features/semantic/semantic.gif" />

### Code completion

<img
alt="completion"
src="https://rvr06.github.io/cornifer/assets/completion.gif" />
src="https://rvr06.github.io/cornifer/docs/features/intellisense/intellisense.gif" />

### Hover

<img
alt="hover"
src="https://rvr06.github.io/cornifer/assets/hover.png" />
src="https://rvr06.github.io/cornifer/docs/features/hover/hover.png" />

### Live preview

<img
alt="preview"
src="https://rvr06.github.io/cornifer/assets/preview.png" />
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)
12 changes: 6 additions & 6 deletions docs/content/docs/c4/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
![](structurizr-1-WSL.png)
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -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)
![](breadcrumb.png)
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -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)
![](format.gif)
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -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)
![](highlighting.gif)
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -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)
![](hover.png)
Original file line number Diff line number Diff line change
Expand Up @@ -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)
![](completion.gif)
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -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)
![](preview.png)
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -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)
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -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)

---

Expand Down Expand Up @@ -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)
![](transpiler_02.png)
File renamed without changes
File renamed without changes

0 comments on commit 7e1fe22

Please sign in to comment.