Hugo installing Themes - Options

Theming Options, modules, git-submodules, or theme copy

Bill Tihen

Last updated on Sun, 05 May 2024 Technology, Website

Getting Started

brew install hugo node

hugo new site yourproject

A good place to start is at: https://themes.gohugo.io/

A few interesting themes (to me)

The officially preferred way. Some themes only allow this - ie: https://github.com/wowchemy/starter-hugo-academic

first update the config.yaml file with:

module:
  imports:
  - path: "github.com/willfaught/paige"

Install the module:

cd yourproject
hugo mod init github.com/youraccount/yourproject
hugo mod get github.com/willfaught/paige

Get theme updates:

cd yourproject
hugo mod get -u

NOTE: I have had problems with some themes as they evolve their theme.

Subtrees Explained - (Easier than Git Submodule)

Example config.yaml:

theme: "paige"

Install:

$ cd yourproject
$ git subtree add --prefix themes/paige --squash https://github.com/willfaught/paige master

Update:

$ cd yourproject
$ git subtree pull --prefix themes/paige --squash https://github.com/willfaught/paige master

Example config.yaml:

theme: "paige"

Install:

$ cd yourproject
$ git submodule add https://github.com/willfaught/paige themes/paige
$ git submodule update --init --recursive --remote

Update:

$ cd yourproject
$ git submodule update --recursive --remote

NOTE: this turns out to be complex with CloudCannon and other web editors

Example config.yaml:

theme: "paige"

Install:

$ cd yourproject
$ git clone https://github.com/willfaught/paige themes/paige
$ rm -rf themes/paige/.git

Update:

$ cd yourproject
$ rm -rf themes/paige
$ git clone https://github.com/willfaught/paige themes/paige
$ rm -rf themes/paige/.git

$ cd yourproject
$ hugo mod npm pack
$ npm install
$ hugo server -D