Workflow

1. Make changes to the site; create a new blog post.
2. Open Terminal
   • command hugo
   • cd to /public
   • make a commit and push to GitHub

How To Use

First thing to do after cloning this repository

Update Submodules

The folders /public and themes/... use files from different repositories. After cloning this repository you have to update the submodules by using the following command:

git submodule update --init --recursive

---

Starting Hugo Server locally

The Hugo Server can be started locally by using the command:

hugo server

Install Hugo

However, the host machine must have Hugo installed beforehand. This can be done my using the Install Guide.

As I use Windows right now, the command to install it on my setup goes as following:

Windows - Chocolatey

choco install hugo -confirm

Making changes to the Website

2 Tiers

1. The static Website and its files
   • here you have the processed and finished files that can be hostet by GitHub Pages. These files can be pushed to your "Blog" or "Website" Repo to be hosted.
2. The Hugo server folder
   • these is your Hugo folder. Here you can do hugo-commands and run a server. This is also the place where you can add new posts / files.
     When you update your Site you have to push the changes from the /public folder indepentally to your Website Repo and the changes you made in this folder to your Hugo Repo.

Adding new Themes

Adding new themes in Hugo is usually done by cloning GitHub repositories. Usually you would simply do a git clone https://examplerepo. But because we need to sync our local folder using git sustainably, what we want to do is using the the submodul feature.

So instead of using clone you have to add the themes as git submodules.

To do so, simply do this command in the root directory of your Hugo folder and let it clone the theme files into the theme directory:

git submodule add https://github.com/your-theme themes/name-of-your-theme

Don't forget to select the new theme by adjusting the name in the config.toml file!