A responsive, minimal, print-friendly resume builder. Powered by Hugo, Tailwind CSS, Nix, and GitHub Pages.
Host your own resume on GitHub for free!
This guide helps you quickly test the theme and deploy your resume to github pages. If you like it, we suggest continuing with the Extended Setup.
Fork this repository, naming it <your_username>.github.io
.
Under (your repo) > Settings > Pages > Build and Deployment > Source
, select "GitHub Actions" as the source.
Go to (your repo) > Actions
and click "Enable workflows". These are disabled by default on forks, to prevent unintended workflow runs.
Edit the resume at (your repo) > exampleSite/content/_index.md
using the github editor. When you commit it, the resume site will automatically be built and deployed to https://<your_username>.github.io
.
Tip
You can skip editing the resume and trigger the build and deploy workflow manually by going to Actions > ./github/workflows/deploy.yaml
and clicking "run workflow".
The fork you created in the Quick Start contains a copy of the theme, which won't be easy to update. Follow this guide to convert your forked hugo site into one which imports the theme.
Clone your forked repository and modify it as follows:
- Delete files and folders marked with a (-).
- Moving the files from
exampleSite
up a level withmv exampleSite/* .
(ignore the error).
$ tree -av --dirsfirst -L 1 --gitignore
.
├── .git
├── .github
├── .vscode
- ├── assets
+ ├── exampleSite/* # move its files to the root dir
- ├── layouts
├── .envrc
├── .gitignore
├── LICENSE
├── README.md
├── biome.json
├── flake.lock
├── flake.nix
- ├── go.mod
- ├── go.sum
- ├── hugo.toml
- ├── package.hugo.json
- ├── postcss.config.js
- └── tailwind.config.js
Rename your module and remove the replacement directive to change modern-hugo-resume
from a local to a remote dependency:
// go.mod (originally from `exampleSite/go.mod`)
- module github.com/cjshearer/modern-hugo-resume/exampleSite
+ module github.com/<your username>/<your repo>
- // We use this for local development. Remove it if you're
- // extracting the exampleSite to your own repository.
- replace github.com/cjshearer/modern-hugo-resume => ../
GitHub Actions is configured to build the site using Nix. Now that your site is built from the root directory (not exampleSite
), you should update its build path and name.
Nix also requires the expected hash of downloaded dependencies. Now that modern-hugo-resume
is imported, you will need to update this hash. Follow the instructions above outputHash
in flake.nix
.
See cjshearer.dev/flake.nix
for reference.
# flake.nix
- buildFolder = "exampleSite";
+ buildFolder = ".";
...
- pname = "modern-hugo-resume-exampleSite"
+ pname = "<your username>.github.io"
...
- outputHash = "sha256-someOldHash=
+ outputHash = "sha256-someNewHash=
Commit and push your changes to your main branch.
git add .
git commit -m "build: use hugo module"
git push
These can be installed manually, or automatically with nix by running nix develop
:
- Install
hugo
1.27.0+extended. - Install
go
>= 1.22.3. - Install
node
>= 20.2.0 with nvm. - Install
pnpm
withcorepack enable
. - Run
pnpm install
withinexampleSite
.
nix develop # open a development environment, with all requirements satisfied
nix build # build the production site, exactly the same way it's done in CI
nix flake check # run formatter/linter checks, exactly the same way it's done in CI
hugo server # serve to localhost and rebuild changes automatically
hugo --minify # build static site for production