Hugo + GitHub Pages + GitHub Actions = ❤️

This repository is a self-contained template to deploy a Hugo static site, hosted on GitHub, and deployed to GitHub Pages hosting, using the continuous integration available through GitHub Actions—all for free.

The theme used by this template is Hugo Apéro 🍷, "a Hugo theme you'll want to hang out with." It is a fork of the Blogophonic Hugo theme. You can visit examples of real websites that use this theme to get some inspiration.

⚙️ Quick Start

Launching a website with this template will take 5-10 minutes:

1. 🪪 Register a GitHub account if you don't already have one.

2. 🪄 Instantiate this template repository by clicking the green "Use this template" button above.

3. 📰 Go to the page of your repository, and select the gh-pages branch as a publishing source, to publish the website on GitHub Pages.

4. 🛠️ Edit the file config.toml to change the value of baseURL: It must reflect the absolute URL of your website, including the protocol (https://), the domain name, and the path to the root of your website. Once you commit this change, the website will be automatically deployed to GitHub Pages! 🥳🎉

5. 📝 Update the README.md so it doesn't look like you just instantiated the template! 😁

Once you are done, you can visit Hugo Apéro's documentation to learn how to customize your website.

⚜️ Using a custom domain

Optionally, instead of publishing on a github.io subdomain, you can publish on a custom domain. To do so, you need to:

• Edit the file .github/workflows/gh-pages.yml to change the value of CNAME to your custom domain name.

• Edit the file config.toml to change the value of baseURL to your custom domain name.

✍️ Credits

This template was created by @jlumbroso, based on the Hugo Apéro theme. It was inspired by reading a post from Silvia Canelón's blog.