Hugo FixIt Blog Template (Git)

👉 English | 简体中文

This is a quick start template for Hugo theme FixIt. It uses Git submodule feature to load the theme. If you favor Go more, you can check this template.

It comes with a basic theme structure and configuration. GitHub action has been set up to deploy the blog to a public GitHub page automatically. Also, there’s a cron job to update the theme automatically everyday.

Directory structure

1
2
3
4
5
6
7
8
9

▸ .github/       # GitHub configuration
▸ archetypes/    # page archetypes (like scaffolds of archetypes)
▸ assets/        # css, js, third-party libraries etc.
▸ config/        # configuration files
▸ content/       # markdown files for hugo project
▸ data/          # blog data (allow: yaml, json, toml), e.g. friends.yml
▸ public/        # build directory
▸ static/        # static files, e.g. favicon.ico
▸ themes/        # theme submodules

Quick Start

For a complete quick start, see this page.

Prerequisites

Hugo: >= 0.132.0 (extended version)

Use this Template

CLI

1

npx fixit-cli create my-blog

Manual

1. Click Use this template, and create your repository on GitHub.

   

2. Once the repository is created, just clone and enjoy it!

   1 2	# Clone with your own repository url git clone --recursive https://github.com/<your_name>/<your_blog_repo>.git

Launching the Site

1
2
3
4

# Development environment
hugo server
# Production environment
hugo server -e production

Build the Site

When your site is ready to deploy, run the following command:

1

hugo

Deploy to GitHub Pages

1. Head to Setting => Actions => General => Workflow permissions => Check “Read and write permissions”.
2. GitHub Pages settings: Setting => Pages => Source: GitHub Actions.
3. Modify config/_default/hugo.toml file baseURL to your site URL.
4. Commit the changes from the previous step to the main branch, and GitHub Actions will automatically build and deploy the site to GitHub Pages.

Update theme

Afterwards you can upgrade the theme with the following command:

1
2

# Update theme manually
git submodule update --remote --merge themes/FixIt

1
2
3
4
5
6
7
8
9

npm install
# build the blog
npm run build
# run a local debugging server with watch
npm run server
# run a local debugging server in production environment
npm run server:production
# update theme submodules
npm run update:theme

Troubleshooting