Install From Scratch

December 2, 2023 1 min read Docs Installation

Getting started from scratch with HB cards theme to build your fast, responsive and modular static websites.

On this page

We offers an example site for getting started with this theme.

Please run these commands from PowerShell or a Linux terminal such as WSL or Git Bash.

Requirements§

Go
Hugo extended version
Node.js 16 or later

Clone the Repository§

1git clone --depth 1 https://github.com/hbstack/theme-cards
sh

Copy the Example Site§

1cp -r theme-cards/exampleSite mysite
sh

Change Working Directory§

1cd mysite
sh

Tweak `go.mod`§

This guide uses sed command to edit the file, please feel free to open and edit the go.mod with your favorite editor.

Replace Module Path§

The module path is the identifier of your site, which typically is your repo URL, take github.com/user/repo as an example, you’ll need to replace the module github.com/hbstack/theme-cards/exampleSite with module github.com/user/repo.

1sed -i '1s/.*/module github.com\/user\/repo/' go.mod
sh

Delete the `replace` Directive§

To build the site successfully, you’ll need to delete the internal used replace directive: replace github.com/hbstack/theme-cards => ../.

1sed -i '/^replace/d' go.mod
sh

Install Dependencies§

1npm ci
sh

Hugo Module Proxy (Optional)§

A Hugo module proxy is required when the default proxy isn’t accessible from your location, i.e. China.

Preview Locally§

1npm run dev
sh

What’s Next?§

Tweak Configurations, such as baseURL, giscus.* and so on.
Remove testing content.
Read the documentations.
Find more modules.

Migrate from HB Starter Theme

Browse Docs