Theme Installation

Contents

Install FixIt theme for your Hugo site in a few steps.

  1. Configure the default theme to FixIt in hugo.toml, e.g. theme = "FixIt"
  2. Install the theme by one of the following ways.

Prerequisites

Hugo (extended edition) and Dart Sass are required dependencies of this theme.

Important

Dart Sass is required to transpile the theme’s SCSS to CSS.

Although not required in all cases, Git, Go and Node.js are commonly used when working with Hugo.

Git is required to:

Go is required to:

Node.js is required to:

Please refer to the relevant documentation for installation instructions:

Installations

You can download the latest release  .zip file of the theme and extract it in the themes directory.

To upgrade the theme by replacing the old theme with the new one.

In this way, just clone the FixIt theme into the themes directory.

1
git clone https://github.com/hugo-fixit/FixIt.git themes/FixIt

To upgrade the theme by pulling the latest commits from the repository.

1
2
cd themes/FixIt
git pull

Click to quickly create a blog! github.com/hugo-fixit/hugo-fixit-starter1/generate

Initialize an empty Git repository in the current directory.

1
git init

Add FixIt to your project as a Git submodule stored in the themes directory.

1
git submodule add https://github.com/hugo-fixit/FixIt.git themes/FixIt

To upgrade the theme by using the following command:

1
git submodule update --remote --merge themes/FixIt

Click to quickly create a blog! github.com/hugo-fixit/hugo-fixit-starter/generate

In this way, you don’t need to configure theme = "FixIt" in hugo.toml.

The easiest way to use a Module for a theme is to import it in the config. See Use Hugo Modules.

  1. Initialize the hugo module system: hugo mod init github.com/<your_user>/<your_project>

  2. Import the theme:

    1
    2
    3
    4
    
    [module]
    
    [[module.imports]]
    path = "github.com/hugo-fixit/FixIt"

To update or manage versions, you can use hugo mod get.

1
2
3
4
5
6
7
8
# Update all modules
hugo mod get -u
# Update all modules recursively
hugo mod get -u ./...
# Update one module
hugo mod get -u github.com/hugo-fixit/FixIt
# Get a specific version (e.g. v1.0.0, @latest, @main)
hugo mod get github.com/hugo-fixit/FixIt@v1.0.0

ManualGit CloneGit SubmodulesHugo Modules
PrerequisitesHugoHugo, GitHugo, GitHugo, Git, Go
Easy to install?
Easy to upgrade or downgrade?✔️✔️
Download speed?✔️
Automatic updates?
Latest version available?

Versioning

FixIt follows Semantic Versioning. The stable version is determined by GitHub Releases, while the main branch contains development changes and unreleased new features.

  • For production sites, always use a tagged release (e.g. v1.0.0).
  • The main branch may include breaking changes and is not guaranteed to be stable.

When using Hugo Modules, pin to a specific version:

1
hugo mod get github.com/hugo-fixit/FixIt@v1.0.0

When using Git Submodules, checkout a specific tag:

1
2
cd themes/FixIt
git checkout v1.0.0

CLI

Tip

The CLI assumes prior knowledge of Hugo and FixIt. If you are new to Hugo or FixIt, we strongly suggest going through the theme documentation without any scaffold tools before using the CLI.

npx fixit-cli create my-blog

FixIt provides an official CLI for quickly scaffolding ambitious Hugo FixIt site skeleton. It provides two ways to quickly scaffold Hugo FixIt site based on Git Submodules or Hugo Modules, and provides the ability to check the latest version of the FixIt theme. See the FixIt CLI docs for more details.

The supported template presets are:


Related Content

Buy me a coffee
Lruihao AlipayAlipay
Lruihao WeChat PayWeChat Pay

Update Available

A new version of this site is available.