Apuntes personales de software y hardware libres.
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 391677c850
doc: Add kicad and py4web notes
11 months ago
.github Initial commit 12 months ago
archetypes Initial commit 12 months ago
config/_default fix: Fix menu configuration 11 months ago
content doc: Add kicad and py4web notes 11 months ago
static dev: First configuration of new FixIt theme 11 months ago
themes Initial commit 12 months ago
.gitignore Initial commit 12 months ago
.gitmodules Initial commit 12 months ago
LICENSE Initial commit 12 months ago
README.en.md Initial commit 12 months ago
README.md Initial commit 12 months ago
package.json Initial commit 12 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

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

    image
  2. 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

Troubleshooting

remote: Permission to git denied to github-actions[bot]. Head to Setting => Actions => General => Workflow permissions => Check "Read and write permissions".