From e9cf972d9c785e6e2f3347689c362e3007078518 Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Thu, 18 Dec 2025 17:45:07 +0100 Subject: [PATCH 1/5] Clean up border-radius --- docs/assets/scss/docs/modules/_article-container.scss | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/assets/scss/docs/modules/_article-container.scss b/docs/assets/scss/docs/modules/_article-container.scss index f5dcb49..57a005e 100644 --- a/docs/assets/scss/docs/modules/_article-container.scss +++ b/docs/assets/scss/docs/modules/_article-container.scss @@ -67,7 +67,7 @@ $article-container-min-height: 460px; } pre { - border-radius: 0 !important; + border-radius: 0; code { padding-right: var(--code-block-padding); @@ -75,6 +75,10 @@ $article-container-min-height: 460px; } } + table tr td pre { + border-radius: 0; + } + .hl { margin: 0 calc(var(--code-block-padding) * -1); padding: 0 var(--code-block-padding); @@ -84,7 +88,7 @@ $article-container-min-height: 460px; li { .highlight { > .chroma { - border-radius: $code-block-border-radius !important; + border-radius: $code-block-border-radius; margin-left: unset; margin-right: unset; From c2b43b11ee6f52af57c187524f6c27ec4cae0504 Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Thu, 18 Dec 2025 18:05:18 +0100 Subject: [PATCH 2/5] Update the `README.md` --- README.md | 24 ++++++++++++++---------- docs/layouts/_shortcodes/highlight.html | 3 ++- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 6b5653e..042f520 100644 --- a/README.md +++ b/README.md @@ -24,15 +24,16 @@ into the pages, please see the [`_code/EMBEDDING.md`](_code/EMBEDDING.md) file. ## Prerequisites -1. Install [Java JDK] version `11` to build the site. -2. Install [Go][go] at least version `1.12`. -3. Install [Node.js][nodejs]. Its version should be `18+`. -4. Install [Hugo Extended][hugo-quick-start] at least version `v0.150.0` or higher. -5. Get access to the [`site-commons`][site-commons] repository from the admins - to be able to download the theme. -6. Make sure [SSH][site-commons-ssh] is configured correctly and the passphrase - is stored in the keychain. -7. Install project dependencies from the `site` directory by running `npm install`. +1. [JDK 11][jdk-11]. +2. [Go][go] `1.12` or newer. +3. [Node.js][nodejs] `18+`. +4. [Hugo Extended][hugo-quick-start] in version `v0.150.0` or higher. +5. Access to the [`site-commons`][site-commons] repository — to download the theme. + +## Configuration + +1. [SSH][site-commons-ssh] configured correctly and the passphrase is stored in the keychain. +2. Install project dependencies from the `site` directory by running `npm install`. ## Running the documentation locally @@ -67,12 +68,14 @@ Another way to run the site locally is to follow these steps: If you receive a `permission denied` message, but you are sure that you have all the rights to the [required repositories](#prerequisites), try clearing -the cache and run the `hugo serve` again: +the cache: ```shell hugo mod clean --all ``` +Then run the `hugo serve` again. + ## Theme updates This project uses several components from the [`site-commons`][site-commons] @@ -174,3 +177,4 @@ in `site/assets/scss`. They will not be available on `spine.io`. [authoring-guide]: https://github.com/SpineEventEngine/SpineEventEngine.github.io/blob/master/AUTHORING.md [spine-repo]: https://github.com/SpineEventEngine/SpineEventEngine.github.io [spine-wiki]: https://github.com/SpineEventEngine/documentation/wiki +[jdk-11]: https://docs.aws.amazon.com/corretto/latest/corretto-11-ug/downloads-list.html diff --git a/docs/layouts/_shortcodes/highlight.html b/docs/layouts/_shortcodes/highlight.html index 6cdf7ad..67a113b 100644 --- a/docs/layouts/_shortcodes/highlight.html +++ b/docs/layouts/_shortcodes/highlight.html @@ -4,7 +4,8 @@ the simple code block without layout changes. Parameters: - * `lang`. The language of the code block. + * `lang`. The language syntax. See the supported languages here + https://gohugo.io/content-management/syntax-highlighting/#languages. * `params`. Optional standard Hugo highlighting parameters as a string. * `file`. An optional name of the code file to display on the code header panel. * `class`. An optional class name that the code block will be wrapped in. From 6dfa7d611d3a7cb515e8d895db5523133f342fc1 Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Thu, 18 Dec 2025 18:06:38 +0100 Subject: [PATCH 3/5] Remove the duplicated section with `embed-code` --- README.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/README.md b/README.md index 042f520..7bcf92d 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,6 @@ This repository is made to be self-sustainable in terms of editing. A fully-fledged Hugo site has been set up for it. All the contents and links are working as intended. It allows making changes more convenient for authors. -The code samples used on the site and in the framework documentation are added -using the [`embed-code`][embed-code] tool (Go version). - -The code resides under the `_code` directory. For instructions on embedding the code -into the pages, please see the [`_code/EMBEDDING.md`](_code/EMBEDDING.md) file. - ## Prerequisites 1. [JDK 11][jdk-11]. @@ -105,7 +99,7 @@ To get theme updates: ## Code samples The code samples used in the framework documentation are added using -the [`embed-code`][embed-code] Go subcommand. +the [`embed-code`][embed-code] tool (Go version). The code resides under the `_code` directory. For instructions on embedding the code into the pages, please see the [`EMBEDDING.md`](./_code/EMBEDDING.md) file. From 2f1f2d846a8e0764f71e59e4918c0160de5cb37d Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Thu, 18 Dec 2025 18:20:12 +0100 Subject: [PATCH 4/5] Change the Java version from 11 to 8 --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 7bcf92d..1c764e7 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ are working as intended. It allows making changes more convenient for authors. ## Prerequisites -1. [JDK 11][jdk-11]. +1. JDK 8 (x86_64). 2. [Go][go] `1.12` or newer. 3. [Node.js][nodejs] `18+`. 4. [Hugo Extended][hugo-quick-start] in version `v0.150.0` or higher. @@ -171,4 +171,3 @@ in `site/assets/scss`. They will not be available on `spine.io`. [authoring-guide]: https://github.com/SpineEventEngine/SpineEventEngine.github.io/blob/master/AUTHORING.md [spine-repo]: https://github.com/SpineEventEngine/SpineEventEngine.github.io [spine-wiki]: https://github.com/SpineEventEngine/documentation/wiki -[jdk-11]: https://docs.aws.amazon.com/corretto/latest/corretto-11-ug/downloads-list.html From 08594ef4b55746ace0df683113fa0f3fc80f45af Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Thu, 18 Dec 2025 18:23:49 +0100 Subject: [PATCH 5/5] Clean up --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1c764e7..4d6a5be 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ are working as intended. It allows making changes more convenient for authors. ## Configuration -1. [SSH][site-commons-ssh] configured correctly and the passphrase is stored in the keychain. +1. Make sure [SSH][site-commons-ssh] configured correctly and the passphrase is stored in the keychain. 2. Install project dependencies from the `site` directory by running `npm install`. ## Running the documentation locally