You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Sergio Alvariño
569fc7812a
|
4 months ago | |
---|---|---|
.github | 11 months ago | |
archetypes | 11 months ago | |
config/_default | 4 months ago | |
content | 4 months ago | |
static | 9 months ago | |
themes | 4 months ago | |
.gitignore | 11 months ago | |
.gitmodules | 11 months ago | |
LICENSE | 11 months ago | |
README.en.md | 11 months ago | |
README.md | 11 months ago | |
package.json | 11 months ago |
README.en.md
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.
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
▸ .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.109.0 (extended version)
Use this Template
-
Click Use this template, and create your repository on GitHub.
-
Once the repository is created, just clone and enjoy it!
# Clone with your own repository url git clone --recursive https://github.com/<your_name>/<your_blog_repo>.git
Launching the Site
# Development environment
hugo server
# Production environment
hugo server -e production
Build the Site
When your site is ready to deploy, run the following command:
hugo
Update theme
Afterwards you can upgrade the theme with the following command:
# Update theme manually
git submodule update --remote --merge themes/FixIt
Start via NPM script
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