guide on Yore

Color Schemes

Wed, 21 Jan 2026 10:30:00 +0800

Yore ships with several built-in color schemes, selectable via themeColorScheme in hugo.yaml.

A color scheme is a CSS file that defines three groups of color tokens, --clr-neutral-*, --clr-brand-*, and --clr-accent-*, which serve as the foundation from which the entire theme derives its colors.

Feature Images

Thu, 15 Jan 2026 14:45:00 +0800

Feature images in Yore appear as hero banners, thumbnails, and social sharing metadata.

Automatic Detection

When using index.md inside a directory (creating a leaf bundle), Yore automatically detects images with the feature* prefix and uses them as the page's feature image.

Getting Started

Thu, 15 Jan 2026 14:45:00 +0800

Prerequisites

extended version, the minimum version is v0.164.0.
version manager.
, the minimum version is v1.20.0.

Installing Yore

Create a site if you don't have one yet:

Authors

Sat, 18 Apr 2026 09:01:00 +0800

Authors are modeled as a . Each author has a dedicated content directory with a profile page, and posts reference authors by slug.

Configuration

Customization

Mon, 02 Feb 2026 16:55:00 +0800

Override Templates

Hugo provides a robust mechanism for template overriding. If the default layout or functionality of a specific theme component does not meet your requirements, you can override it by recreating the file at the equivalent path within your project's root directory.

Favicon

Fri, 30 Jan 2026 21:09:00 +0800

Favicons are icons that represent websites on browser tabs. This page explains how to provide favicon resources and how to customize them when the default formats are insufficient.

Setup

Place the following assets in the /assets/favicons directory.

Series

Wed, 21 Jan 2026 08:52:00 +0800

The Series feature groups multiple articles published across different dates or sections into a named sequence.

Series is implemented as a taxonomy, which is why the front matter variable is defined as a list of strings.

Stale Content Warning

Wed, 22 Jul 2026 00:08:00 +0800

The stale content warning shows an admonition on an article when it has not been updated within a configurable number of days. The partial reads lastmod in front matter, and falls back to date.

Random Page

Wed, 22 Jul 2026 20:59:00 +0800

The random page lets readers discover a random article, giving older posts a chance to be seen again. Visiting this page picks a random page from the site and redirects the visitor to it, showing the chosen page's title with a typing animation before redirecting.

Hosting

Thu, 22 Jan 2026 16:30:00 +0800

Prerequisites

Before deploying, make sure your site builds locally with hugo without errors.

Deploy to GitHub Pages

GitHub Pages builds your site using GitHub Actions. The workflow installs Hugo, runs Pagefind, and publishes the result. Your repository must be hosted on GitHub.

Search

Thu, 22 Jan 2026 16:30:00 +0800

Built-in search is powered by , a static search library that serves results entirely in the browser with no external service needed.

Enabling search requires two steps: setting a config flag so Yore renders the search UI, and running Pagefind after every build to generate the search index. Both are required because the UI will not work without the index.

Page Actions

Sun, 19 Apr 2026 06:50:00 +0800

Page actions add a per-page dropdown menu with utilities for sharing and inspecting content.

Configuration

All keys go under params in hugo.yaml. pageShowActions can also be set per-page in front matter.

Backlinks

Thu, 22 Jan 2026 16:40:00 +0800

Yore embeds a backlink system based on to track and display bidirectional links.

Configuration

Add backlinks to outputs.home to generate the backlink index, and set pageShowBacklinks: true to display backlinks on pages:

Service Worker

Sat, 27 Jun 2026 00:00:00 +0800

The Service Worker intercepts network requests to serve cached assets as a fallback when offline, keeping the site accessible without a network connection.

The Service Worker is intentionally disabled in local development to prevent it from interfering with live page reloads and content updates.

Knowledge Graph

Sat, 02 May 2026 11:59:00 +0800

Knowledge Graph visualizes and taxonomy relationships between articles as an interactive graph. Yore supports with no additional HTML/CSS configuration.

Installation & Configuration

Pick one of these methods to set up.

Cookie Consent

Sat, 28 Mar 2026 18:00:00 +0800

Yore integrates for GDPR-compliant cookie management. Built-in categories are necessary, functional, analytics, and advertising.

Important

Google Ads related products are with vanilla-cookieconsent.
Most libraries exclude functional cookies from consent handling and . Yore follows the same behavior and does not manage them.
Provide a cookie settings entry accessible from all pages to meet GDPR requirements.

Configuration

Set enable: true and list the categories you want to expose to visitors.

Versioning

Fri, 17 Apr 2026 00:00:00 +0800

Versioning serves multiple doc versions. Each version maps to a content directory and gets its own URL prefix.

How It Works

Hugo builds one independent site per version declared in versions. Each site receives only the content directories that match its sites.matrix.versions constraint, controlled through Hugo's module mount system, which maps source directories to the content target at build time.

guide on Yore

Color Schemes

Feature Images

Automatic Detection

Getting Started

Prerequisites

Installing Yore

Authors

Configuration

Customization

Override Templates

Favicon

Setup

Series

Stale Content Warning

Archive

Setup

Random Page

Hosting

Prerequisites

Deploy to GitHub Pages

Search

Page Actions

Configuration

Backlinks

Configuration

Service Worker

Knowledge Graph

Installation & Configuration

Cookie Consent

Configuration

Versioning

How It Works