Hugo Theme Chirpy Starter Template

This is a quick start template for Hugo Theme Chirpy. 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.

Get started

1. Click Use this template, and create your repository as <username>.github.io on GitHub.

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

3. And voila! You're ready to go. The codespace has been configured with the latest version of Hugo extended, just run hugo server in the terminal and see your new site in action.

4. Check config folder for the configuration files. You can edit them to suit your needs. Make sure to update the baseURL property in hugo.toml to your site's URL.

5. Open Settings -> Pages. Change the build branch from main to gh-pages.

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.

Update theme manually

Run:

hugo mod get -u github.com/geekifan/hugo-theme-chirpy
hugo mod tidy

Credits

This README is modified from hugo-theme-stack-starter.