site-commons

A theme for Spine websites based on Hugo engine.

It provides:

• reusable layouts and partials;
• custom shortcodes for documentation-heavy content;
• shared styling and UI components used across Spine web projects.

Prerequisites

1. Go 1.12 or newer.
2. Hugo Extended in version v0.150.0 or higher.

Installation

1. Initialize your Hugo website as the Hugo Module:

   hugo mod init github.com/SpineEventEngine/<repo-name>

2. Add this theme import to your hugo.toml configuration file:

   [module]
     [[module.imports]]
       path = 'github.com/SpineEventEngine/site-commons'

Theme updates

1. Get theme updates:

   hugo mod get -u github.com/SpineEventEngine/site-commons

2. Commit and push changes from go.mod and go.sum files.

Usage

Use the theme as the base for the site templates and content rendering.

For a guide with a complete list of theme components, see the COMPONENTS.md.

Development

When editing this theme:

• keep components and shortcodes reusable;
• update COMPONENTS.md when adding or changing components.