Create the layout and components for the documentation in Hugo

_hugo-site/.browserslistrc

@@ -0,0 +1,2 @@
+> 0.5%
+last 2 versions

_hugo-site/.gitignore

@@ -0,0 +1,28 @@
+# Hugo cache files
+/resources
+public
+
+# Cache folder for Hugo Modules
+_vendor
+
+# Node modules
+node_modules
+
+# Used to control concurrency between multiple Hugo instances
+.hugo_build.lock
+
+# Needed for navigation/intellisense help inside code editors
+jsconfig.json
+
+# IntelliJ IDEA modules and interim config files
+*.iml
+.idea/*.xml
+.idea/.name
+.idea/artifacts
+.idea/libraries
+.idea/modules
+.idea/shelf
+
+!.idea/misc.xml
+!.idea/codeStyles/
+!.idea/copyright/

_hugo-site/assets/scss/docs/_home.scss

@@ -0,0 +1,64 @@
+/*!
+ * Copyright 2025, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+.home {
+  background-color: $body-light-gray-color;
+  font-family: $main-font;
+
+  .container {
+    background-color: white;
+    border: 1px solid #e6ecf1;
+    max-width: 760px;
+    padding: 48px 56px;
+
+    @media (max-width: $phone-medium) {
+      padding: 24px;
+    }
+
+    h1 {
+      font-size: $font-size--xxxl;
+      font-weight: 300;
+      color: rgba(0, 0, 0, .4);
+      line-height: 1.2;
+      margin-bottom: 32px;
+      padding-top: 16px;
+
+      @media (max-width: $phone-medium) {
+        font-size: $font-size--xl;
+      }
+    }
+
+    a {
+      color: $main-brand-color;
+    }
+
+    .subtle {
+      color: rgba(0, 0, 0, .46);
+      margin-top: 40px;
+      font-size: 14px;
+    }
+  }
+}

_hugo-site/assets/scss/docs/_layout.scss

@@ -0,0 +1,33 @@
+/*!
+ * Copyright 2025, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+.page-content {
+  .three-column {
+    .sticky-col {
+      top: 0;
+    }
+  }
+}

_hugo-site/assets/scss/main.scss

@@ -0,0 +1,38 @@
+/*!
+ * Copyright 2025, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+@import "node_modules/bootstrap/scss/bootstrap";
+
+@import "docs-common";
+@import "docs";
+
+/*
+Styles that should only be used to build this site.
+They should not be imported into the main spine.io site
+to not override or duplicate styles there.
+*/
+@import "docs/home";
+@import "docs/layout";

_hugo-site/config/_default/hugo.toml

@@ -0,0 +1,47 @@
+baseURL = 'https://spine.io/'
+languageCode = 'en-us'
+title = 'Documentation preview'
+
+[module]
+  # First theme has higher priority than later ones.
+  [[module.imports]]
+    path = '../../_hugo-theme'
+  [[module.imports]]
+    path = 'github.com/TeamDev-Ltd/site-commons'
+
+# Enables HTML rendering in markdown files.
+[markup]
+  [markup.goldmark]
+    [markup.goldmark.renderer]
+      unsafe = true
+  [markup.highlight]
+    noClasses = false
+
+# Version control config.
+# To change the current main version, update only the `path` parameter.
+# Read more in the `SPINE_RELEASE.md` guide.
+#
+# The same settings should be copied to the `SpineEventEngine/SpineEventEngine.github.io`
+# project due to the issue with the cascade arrays:
+# https://github.com/gohugoio/hugo/issues/13869
+[[cascade]]
+  [cascade.params]
+    url = 'docs/'
+  [cascade.target]
+    # The path to the `_index.md` of the current main version.
+    path = '{/docs/1}'
+    kind = 'section'
+[[cascade]]
+  [cascade.params]
+    url = 'docs/:sections[2:]/'
+  [cascade.target]
+    # The path to the current main version.
+    path = '{/docs/1/**}'
+    kind = 'section'
+[[cascade]]
+  [cascade.params]
+    url = 'docs/:sections[2:]/:contentbasename/'
+  [cascade.target]
+    # The path to the current main version.
+    path = '{/docs/1/**}'
+    kind = 'page'

_hugo-site/content/_index.md

@@ -0,0 +1,14 @@
+---
+title: Documentation preview
+---
+
+# Welcome to Spine Documentation
+
+Go to the [documentation section](docs/).
+
+Read a [guide][authoring] on adding the content to the documentation.
+
+<p class="subtle">The page is only available on this site and will not be 
+rendered on the <a href="https://spine.io">spine.io</a>.</p>
+
+[authoring]: https://github.com/SpineEventEngine/SpineEventEngine.github.io/blob/master/AUTHORING.md

_hugo-site/go.mod

@@ -0,0 +1,5 @@
+module github.com/SpineEventEngine/documentation/_hugo-site
+
+go 1.22.0
+
+require github.com/TeamDev-Ltd/site-commons v0.0.0-20251120141426-5f3b352019cd // indirect

_hugo-site/go.sum

@@ -0,0 +1,2 @@
+github.com/TeamDev-Ltd/site-commons v0.0.0-20251120141426-5f3b352019cd h1:Y2fDtQOb628jO1Niky7Xfvs/mVdXmYeCwc+TdHaVa04=
+github.com/TeamDev-Ltd/site-commons v0.0.0-20251120141426-5f3b352019cd/go.mod h1:atDeksDWBzsIidpW6Ivz2yYHwp2JPa1i1KXIxkctQ3c=

_hugo-site/layouts/_default/baseof.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en"
+      itemscope itemtype="https://schema.org/WebPage"
+      prefix="og: http://ogp.me/ns#">
+{{ partial "head/head.html" . }}
+{{ $bodyClass := partial "functions/get-body-class.html" . }}
+<body class="{{ $bodyClass }}">
+    <div class="wrapper">
+        <div class="content">
+            {{ block "main" . }}{{ end }}
+        </div>
+    </div>
+    {{ partial "scripts/body-scripts.html" . }}
+</body>
+</html>

_hugo-site/layouts/_default/page.html

@@ -0,0 +1,3 @@
+{{ define "main" }}
+    {{ .Content }}
+{{ end }}

_hugo-site/layouts/_default/section.html

@@ -0,0 +1,3 @@
+{{ define "main" }}
+    {{ .Content }}
+{{ end }}

_hugo-site/layouts/_partials/head/head.html

@@ -0,0 +1,35 @@
+<!--
+  ~ Copyright 2025, TeamDev. All rights reserved.
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~ http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Redistribution and use in source and/or binary forms, with or without
+  ~ modification, must retain the above copyright notice and the following
+  ~ disclaimer.
+  ~
+  ~ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+  ~ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+  ~ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+  ~ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+  ~ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+  ~ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+  ~ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+  ~ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+  ~ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  ~ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  ~ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  -->
+
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    {{ partial "head/title.html" . }}
+    {{ partial "docs/head/code-theme.html" . }}
+    {{ partial "head/stylesheet.html" . }}
+    {{ partial "scripts/head-scripts.html" . }}
+</head>

_hugo-site/layouts/_partials/head/stylesheet.html

@@ -0,0 +1,43 @@
+<!--
+  ~ Copyright 2025, TeamDev. All rights reserved.
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~ http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Redistribution and use in source and/or binary forms, with or without
+  ~ modification, must retain the above copyright notice and the following
+  ~ disclaimer.
+  ~
+  ~ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+  ~ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+  ~ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+  ~ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+  ~ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+  ~ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+  ~ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+  ~ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+  ~ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  ~ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  ~ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  -->
+
+{{ partial "docs/head/icon-font.html" . }}
+
+{{ $options := (dict
+    "targetPath" "main.css"
+    "outputStyle" "compressed"
+    "includePaths" (slice "node_modules")
+) }}
+
+{{ $postCSSConfig := dict "config" "postcss.config.js" }}
+{{ $scssPath := "scss/main.scss" }}
+{{ $style := resources.Get $scssPath | toCSS $options | postCSS $postCSSConfig }}
+
+{{ if ne hugo.Environment "development" }}
+    {{ $style = $style | resources.Minify | fingerprint }}
+{{ end }}
+
+<link rel="stylesheet" href="{{ $style.RelPermalink }}" crossorigin="anonymous">

_hugo-site/layouts/_partials/head/title.html

@@ -0,0 +1,30 @@
+<!--
+  ~ Copyright 2025, TeamDev. All rights reserved.
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~ http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Redistribution and use in source and/or binary forms, with or without
+  ~ modification, must retain the above copyright notice and the following
+  ~ disclaimer.
+  ~
+  ~ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+  ~ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+  ~ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+  ~ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+  ~ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+  ~ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+  ~ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+  ~ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+  ~ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  ~ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  ~ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  -->
+
+{{ $title := .Title | default site.Params.title }}
+{{ $title = replace $title "&nbsp;" " " }}
+
+<title>{{ $title }}</title>