Installation Guide

This guide will walk you through installing the Sans theme for your Hugo site.

Prerequisites

Before installing the Sans theme, ensure your development environment meets the following requirements:

Confirm that Hugo is properly installed and meets the minimum version requirement:

1
hugo version

Expected output:

1
hugo v0.146.0+extended darwin/amd64 BuildDate=...

Important: Ensure you have the Extended version of Hugo installed, as the theme requires Hugo Extended features for SCSS/Sass processing.

1
git --version

1
2
node --version
npm --version

Using Git submodules is the recommended approach as it allows easy theme updates and maintains a clean separation between your content and the theme.

If your site isn’t already a Git repository:

1
2
cd your-hugo-site
git init

1
git submodule add https://github.com/psugam/sans themes/sans

This creates a themes/sans directory containing the theme.

Copy the following directories from the theme to your site root:

1
2
3
cp -r themes/sans/exampleSite/content ./
cp -r themes/sans/exampleSite/assets ./
cp -r themes/sans/exampleSite/config ./

Move hugo.toml from the config folder to your site root:

1
mv config/hugo.toml ./hugo.toml

Open hugo.toml and verify the theme name is set correctly:

1
theme = "sans"

1
hugo server

Visit http://localhost:1313 to see your site.

If you prefer not to use Git submodules, you can manually download the theme.

1
2
# Assuming extracted folder is named 'sans-theme-main'
mv sans-theme-main your-hugo-site/themes/sans

Important: Ensure the theme folder is named exactly sans (not sans-theme-main or any other variation).

Follow the same steps as Option A (Steps 3-6):

After installation, your site structure should look like this:

1
2
3
4
5
6
7
8
9
your-hugo-site/
├── assets/
├── config/
├── content/
├── themes/
│   └── sans/
├── hugo.toml
├── package.json
└── node_modules/

Edit hugo.toml or configuration files in the config/ directory to customize:

Refer to the Configuration Guide for detailed options.

1
2
cd your-hugo-site
git submodule update --remote --merge

Now that you’ve installed the Sans theme, you can: