Skip to content

A quick-start template base on Git submodule to create a Hugo FixIt site.

License

Notifications You must be signed in to change notification settings

tomisacatyet/hugo-fixit-blog-git

 
 

Repository files navigation

Hugo FixIt Blog Template (Git)

This is a quick start template for Hugo theme FixIt. It uses Git submodule 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.

  1. Click Use this template, and create your repository on GitHub.
  2. Once the repository is created, just clone and enjoy it!

Directory structure

▸ .github/       # GitHub configuration
▸ .shell/        # shell commands for hugo project, entrance: hugo_main.sh
▸ 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

Just install latest version of Hugo(>= 0.89.0) for your OS (Windows, Linux, macOS).

# Clone with your own repository url
git clone --recursive git@github.com:hugo-fixit/hugo-fixit-blog-git.git

There are two ways to start this blog.

NPM

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

Hugo

# Development environment
hugo server --disableFastRender --navigateToChanged --bind 0.0.0.0
# Production environment
hugo server --disableFastRender --navigateToChanged --environment production --bind 0.0.0.0

In addition, you can run hugo_main.sh to choice frequently-used Hugo commands:

cd .shell && sh hugo_main.sh
--------------Hugo Admin--------------
Please enter the serial number to work
--------------------------------------
1. post
2. server
3. server:production
4. build
5. submodule-sync
6. push
--------------------------------------
Press Ctrl+C to stop

About

A quick-start template base on Git submodule to create a Hugo FixIt site.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published