spine.io site

This repository contains the code of the spine.io site. It is based on Hugo and is hosted on GitHub Pages.

This project is two-headed:

• It is a Hugo project.
• It is a Gradle project to for checking the source code embedded to the site.

The code samples used on the site and in the framework documentation are added using the 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 file.

Prerequisites

1. JDK 8 (x86_64).
2. Go 1.12 or newer.
3. Node.js 18+.
4. Hugo Extended in version v0.150.0 or higher.
5. Access to the site-commons repository — to download the theme.

Configuration

1. Make sure 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 site locally

To build and launch the site on the local server:

./gradlew :runSite

To build the site without running the server:

./gradlew :buildSite

Another way to run the site locally is to follow these steps:

1. Navigate to the site folder.

2. Start the local server with this command:

   hugo server

If you receive a permission denied message, but you are sure that you have all the rights to the required repositories, try clearing the cache:

hugo mod clean --all

Then run the hugo serve again.

Documentation

The documentation is located in a separate repository. It is added to this site as a Hugo Module.

Any changes to the documentation must be made in its own repository.

The documentation 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 in it are working as intended. It allows making changes to it more convenient for authors.

In terms of building the “main” site, the Hugo Modules are used to embed the content.

Steps to get documentation updates

1. Navigate to the site directory.

2. Clean the module cache:

   hugo mod clean

3. Get the documentation Hugo Module:

   hugo mod get -u github.com/SpineEventEngine/documentation/docs

4. Commit and push changes from go.mod and go.sum files. In the go.sum file, keep only the two required entries for each theme to avoid file clutter.

Common theme

This project uses the site-commons Hugo theme for general components such as anchor icons, snackbars, etc.

1. Navigate to the site directory.

2. To get theme updates, run:

   hugo mod get -u github.com/TeamDev-Ltd/site-commons

3. Commit and push changes from go.mod and go.sum files. In the go.sum file, keep only the two required entries for each theme to avoid file clutter.

Authoring

For instructions on adding the content to the site, please see the AUTHORING.md file.