https://github.com/jlumbroso/hugo-apero-github-template
Template to run a Hugo Apéro 🍸🍷 themed website on GitHub Pages. ⚙️🤖
https://github.com/jlumbroso/hugo-apero-github-template
github-template hugo-template website-template
Last synced: about 1 month ago
JSON representation
Template to run a Hugo Apéro 🍸🍷 themed website on GitHub Pages. ⚙️🤖
- Host: GitHub
- URL: https://github.com/jlumbroso/hugo-apero-github-template
- Owner: jlumbroso
- Created: 2022-11-26T14:21:05.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-27T00:04:52.000Z (about 3 years ago)
- Last Synced: 2025-01-29T22:33:15.571Z (about 1 year ago)
- Topics: github-template, hugo-template, website-template
- Language: HTML
- Homepage: https://jlumbroso.github.io/hugo-apero-github-template/
- Size: 19.2 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hugo + GitHub Pages + GitHub Actions = ❤️
This repository is a **self-contained template** to deploy a
[Hugo static site](https://gohugo.io/), hosted on [GitHub](https://github.com), and deployed to [GitHub Pages](https://pages.github.com)
hosting, using the continuous integration available through
[GitHub Actions](https://actions.github.com)—all for free.
The theme used by this template is [Hugo Apéro](https://github.com/hugo-apero/hugo-apero) 🍷, "_a Hugo theme you'll want to hang out with_." It is a fork of the [Blogophonic](https://github.com/formspree/blogophonic-hugo) Hugo theme. You can [visit examples of real websites that use this theme](https://hugo-apero-docs.netlify.app/project/) to get some inspiration.
## ⚙️ Quick Start
Launching a website with this template will take 5-10 minutes:
1. 🪪 [**Register** a GitHub account](https://github.com/join) if you don't already have one.
2. 🪄 **Instantiate** this template repository [by clicking the green "Use this template" button above](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template).
3. 📰 Go to the page of your repository, and [select the `gh-pages` branch as a **publishing source**](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch), 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](https://hugo-apero-docs.netlify.app/) 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**](https://github.com/jlumbroso), based on the [Hugo Apéro](https://github.com/hugo-apero/hugo-apero) theme. It was inspired by reading [a post from Silvia Canelón's blog](https://silviacanelon.com/blog/2021-hello-hugo-apero/).