This is a quick start template for Hugo theme Stack. It uses Hugo modules feature to load the theme.

It comes with a basic theme structure and configuration. GitHub action has been set up to deploy the theme to a public GitHub page automatically. Also, there's a cron job to update the theme automatically everyday.

In case you got lost during the setup process, here's a video tutorial that setups a new Hugo site using this template, and deploys it to GitHub Pages: https://www.youtube.com/watch?v=8qDdQQ6Ifxo

1. Click Use this template, and create your repository as <username>.github.io on GitHub. (You can also use a different repository name, but then the resulting website will be available at https://<username>.github.io/<repository-name>. )

2. Once the repository is created, create a GitHub codespace associated with it.

3. While waiting for the codespace to be created, go to Settings -> Pages of your newly created repository, and set Build and deployment -> Source to GitHub Actions.

4. After the codespace is created, you can test that the site is built successfully by running hugo server in the terminal and see your new site in action.

5. Check config folder for the configuration files. You can edit them to suit your needs. Make sure to update the baseurl property in config/_default/config.toml to your site's URL. For example, if your new repository is named my-blog, then the baseurl should be https://<username>.github.io/my-blog/.

6. Once you're done editing the site, just commit it and push it. GitHub action will deploy the site automatically to GitHub page asociated with the repository.

In case you don't want to use GitHub codespace, you can also run this template in your local machine. You need to install Git, Go and Hugo extended locally. For more information, check official Hugo documentation: https://gohugo.io/installation/

Run:

hugo mod get -u github.com/CaiJimmy/hugo-theme-stack/v4
hugo mod tidy

This starter template has been configured with v4 version of theme. Due to the limitation of Go module, once the v4 or up version of theme is released, you need to update the theme manually. (Modifying config/module.toml file)

Check official Hugo documentation: https://gohugo.io/host-and-deploy/