Quick Start: Deploy Your Blog with One Click

Welcome to Hugo Theme Stack Starter

This is a ready-to-use blog template based on Hugo Theme Stack v4, featuring enhanced styling, bilingual support, and GitHub Actions auto-deployment. You can get started without installing anything locally.

Option 1: GitHub Template — One Click Deploy (Recommended)

The easiest way — everything happens in your browser.

Step 1: Create your repository from this template

Open this project’s GitHub page
Click the green “Use this template” button → “Create a new repository”
Enter a repository name (e.g., my-blog), select Public (required for free GitHub Pages)
Click “Create repository”

Step 2: Enable GitHub Pages

In your new repository, go to Settings → Pages
Under “Source”, select “GitHub Actions”
Save

Step 3: Update your configuration

Edit config/_default/config.toml directly on GitHub:

# Replace with your GitHub Pages URL
baseurl = "https://your-username.github.io/repo-name/"
title   = "My Blog"

Step 4: Push to trigger auto-deployment

Every commit triggers GitHub Actions to build and deploy automatically. Wait 1–2 minutes, then visit your GitHub Pages URL to see your blog live!

Option 2: Local Development

If you prefer to write and preview locally:

Install Hugo (Extended edition)

# macOS
brew install hugo

# Windows (Scoop)
scoop install hugo-extended

# Linux (apt)
sudo apt install hugo

Verify it’s the extended edition:

hugo version
# Output should include "extended"

Clone and run

git clone https://github.com/your-username/my-blog.git
cd my-blog
hugo server

Visit http://localhost:1313 to preview your blog.

Configuration Guide

All config files are in config/_default/:

File	Purpose
`config.toml`	Site title, base URL, default language
`languages.toml`	Multilingual settings (zh/en)
`params.toml`	Theme parameters (comments, homepage layout)
`params.en.toml`	English-specific parameters (avatar, subtitle)
`menu.en.toml`	English navigation menu

Required changes

1. Site title and URL (config.toml):

baseurl = "https://your-domain.com/"
title   = "My Blog"

2. Your avatar and bio (params.en.toml):

[sidebar]
    subtitle = "Your personal tagline"
    avatar   = "img/avatar.jpg"  # replace assets/img/avatar.jpg

3. Blog launch date (params.toml):

[footer]
    launchDate = "2024-01-01"  # your blog's start date

Project Structure

my-blog/
├── .github/workflows/    # GitHub Actions (no changes needed)
├── assets/scss/          # Style customization
│   ├── custom.scss       # Colors, global styles
│   └── partials/custom-components/  # Component styles
├── config/_default/      # All configuration files
├── content/
│   └── post/             # Blog posts (write here)
├── layouts/              # Custom layouts and Shortcodes
└── static/               # Static assets (images, etc.)

What’s Next

📖 Theme Customizations — What this template changes from the original
💬 Set Up Waline Comments — Add a comment section to your blog
✏️ Start Writing — Learn Markdown and multilingual posts

Happy blogging! 🎉