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 Stack 📚, "Card-style Hugo theme designed for bloggers" by @CaiJimmy.
Launching a website with this template will take 5-10 minutes:
-
🪪 Register a GitHub account if you don't already have one.
-
🪄 Instantiate this template repository by clicking the green "Use this template" button above.
-
👮 Enable write permissions for GitHub Actions, by setting the permission level of
GITHUB_TOKENto "Read and write permissions", as described in the documentation. -
📰 Go to the page of your repository, and select the
gh-pagesbranch as a publishing source, to publish the website on GitHub Pages. -
🛠️ Edit the file
config.yanlto change the value ofbaseURL: 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 (this is usuallyhttps://<your GitHub username>.github.io/<the name of the repository>, for instance the original website for this template is https://jlumbroso.github.io/hugo-stack-template/). Once you commit this change, the website will be automatically deployed to GitHub Pages! 🥳🎉 -
📝 Update the
README.mdso it doesn't look like you just instantiated the template! 😁
Once you are done, you can visit Stack's documentation to learn how to customize your website.
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.ymlto change the value ofCNAMEto your custom domain name. -
Edit the file
config.tomlto change the value ofbaseURLto your custom domain name.
This template was created by @jlumbroso, based on the Stack. The theme is licensed GPLv3, and the template is licensed MIT.