Requires Hugo extended v0.160.0 or newer. Older versions and the non-extended build may fail to build this site.
- install Hugo if you don't have it yet
- fork this repo to your own github account with a name like
https://github.com/yourusername/yourusername.github.io - clone your forked repo to your local machine
git clone --recursive https://github.com/yourusername/yourusername.github.io - make changes to the
config.ymlfile and the content files in thecontent/folder - run
hugo serverin the root folder of the repo to preview your homepage - enable github pages in the repo settings, set Code and automation -> Pages -> Source to
Github Actions. - in GitHub repo: Settings -> Environments -> github-pages -> Edit: Deployment branches: set to “All branches” or add exampleSite.
- back to local machine, commit and push your changes to your github repo
- visit
https://yourusername.github.ioto see your homepage live
- github actions for auto-deploying to gh-pages
- update README with more instructions