ryouze.github.io

ryouze.github.io is a personal website built using Hugo.

The website is hosted on GitHub Pages and is accessible at the custom domain ryouze.net.

Motivation

I wanted a personal blog to share my programming tutorials. I chose Hugo because it allows me to write content in Markdown and generate static HTML files that can be hosted on GitHub Pages with minimal effort.

I included a manual theme update script (update-theme.sh) because I could not get the theme to update automatically using Git submodules when running GitHub Actions. Perhaps this will be fixed in the future.

Features

• Automatic rebuilds using GitHub Actions.
• Simple content management with Markdown.

Project Structure

The project is organized as follows:

• .github: GitHub Actions workflows (for automatic rebuilds).
• archetypes: Templates for new posts (e.g., title and date).
• content: Actual website content (posts and projects).
• public: Hugo-generated output website (will be built by CI/CD on push).
• static: Static files (e.g., images, GIFs, videos).
• themes: Theme used by the website.

Tested Systems

This project has been tested on the following systems:

• macOS 15.7 (Sonoma)

Automated builds are performed on the latest versions of Linux.

Requirements

To build this project, you'll need:

• Hugo

Build

Follow these steps to build the project:

1. Clone the repository:

   git clone https://github.com/ryouze/ryouze.github.io.git

2. Change into the project directory:

   cd ryouze.github.io

3. (Optional) Update the Gokarna theme:

   ./update-theme.sh

   This script fetches the latest theme files using git.

4. Build the project:

   hugo --gc --minify

   • --gc cleans Hugo's resource cache so no outdated assets are published.
   • --minify compresses HTML/CSS/JS.

After successful build, the generated static files are written to the public directory.

Development

To create a new post:

hugo new posts/title.md

Note

Hugo creates new content as drafts. Set draft = false before publishing so CI includes the page.

To start the Hugo server locally and view changes in real time:

hugo server -D

-D serves content marked as drafts, which is handy while editing new posts.

To update the Gokarna theme:

./update-theme.sh

Tip

Consider using imageresizer.com to convert images to WebP format for faster loading.

Credits

• Hugo
• Gokarna

Contributing

All contributions are welcome.

License

This project is licensed under the GNU GPLv3 License.