documentation on Yore

Introduction

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

Yore is a simple yet feature-rich Hugo theme, designed specifically for content-heavy blogs, placing textual clarity first. Despite its simplicity, Yore offers multiple layouts, headers, and customization options.

Features

17:1 ultra high text contrast ratios, far exceeding WCAG-AA 4.5:1
Prioritizes information delivery
3 distinct header options
2 page hero styles
3-layered CSS structure for flexible styling
Semantic CSS layer for consistent visual customization
Article series support
Keyboard navigation support
Multilingual/RTL support
Automated responsive image
Perfect Google Lighthouse scores on desktop and mobile
lightweight CSS framework
image galleries
interactive charts
LaTeX notation
site search

Photo credit:

Getting Started

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

Prerequisites

extended version, the minimum version is v0.158.0.
version manager.
(Optional) if you want to install Yore using Hugo module instead of Git submodule.

Installing Yore

Pick one of these three ways to set up the Yore theme on your new site.

Color Schemes

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

Yore comes with several built-in color schemes. To pick the one you like, just set the themeColorScheme option in your hugo.yaml file.

Preview

Try out the different color schemes using the theme switcher below:

Directory Structure and Assets

Fri, 30 Jan 2026 03:54:00 +0800

Understanding Hugo's directory structure is essential for managing content and assets effectively.

Directory Structure

A typical Hugo project follows this structure:

.
├── archetypes/ # Templates for new Markdown files
├── assets/ # Processed assets (images, CSS, JS)
├── content/ # Markdown files and page bundles
├── data/ # Custom configuration data
├── i18n/ # Translation files
├── layouts/ # Custom layout files
├── static/ # Raw static files (favicons, robots.txt)
├── themes/ # Theme files
└── hugo.yaml # Site configuration

This guide focuses on three key directories: assets/, static/, and content/, as these are the ones you'll work with most frequently.

Feature Images

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

Feature images in Yore serve multiple purposes: they appear as hero banners, thumbnails, and social sharing metadata. This functionality relies on Hugo page bundles.

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.

Favicon

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

A favicon is a small icon associated with a website. It is typically displayed in browser tabs, address bars, and bookmark lists to provide a visual identity for the site.

Series

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

The Series feature enables the logical grouping of multiple articles published across different dates or sections. A Series is implemented as a taxonomy, which is why the front matter variable is defined as a list of strings.

Docs Layout

Wed, 18 Mar 2026 22:57:00 +0800

Yore provides a docs layout specifically engineered for deep documentation, featuring a 3-column structure to optimize navigation and readability.

Activation

The docs layout can be applied to content using the following methods:

Search

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

Yore built-in search utilizes to provide client-side indexing and real-time search results.

Configuration

To enable search functionality, you must configure both the global parameters and the Hugo output formats. Ensure the search feature is toggled on:

Backlinks

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

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

Principle

The system utilizes Hugo's render-link hook to capture internal references. It functions by passing the link's destination to the .GetPage method. If Hugo successfully resolves the path to a page, a backlink entry is recorded in the site-wide store.

Fri, 30 Jan 2026 03:14:00 +0800

Hugo provides a built-in related article feature powered by an inverted index algorithm. This mechanism offers high performance, though its reliance on exact string matching requires specific taxonomy strategies to achieve optimal results.

Markdown and Hugo

Tue, 20 Jan 2026 11:30:00 +0800

Semantic Markdown

In static site generation, Markdown is not merely a shorthand for text; it is a direct instruction for generating HTML. Hugo follows the CommonMark specification via the Goldmark engine. Understanding the underlying HTML output is essential for precise layout control.

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.

Reference - Configuration

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

The preconfigured hugo.yaml.

Reference - Front matter

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

These parameters extend standard Hugo functionality and are categorized into global site parameters and page-level front matter.

Blog Config

Article Pages

Configurations of index.md.

Reference - Icons

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

This page lists all built-in icons in Yore.

You can also use custom icons by placing SVG assets in the assets/icons/ directory at your project root. To enable automatic color matching, ensure every SVG path includes the fill="currentColor" attribute.

Markdown Basic Formatting

Tue, 20 Jan 2026 11:30:00 +0800

Basic Markdown example with params.layout: 3-col.

documentation on Yore

Introduction

Features

Getting Started

Prerequisites

Installing Yore

Color Schemes

Preview

Directory Structure and Assets

Directory Structure

Feature Images

Automatic Detection

Favicon

Series

Docs Layout

Activation

Archive

Basic Setup

Search

Configuration

Backlinks

Principle

Related Article

Markdown and Hugo

Semantic Markdown

Customization

Override Templates

Reference - Configuration

Reference - Front matter

Blog Config

Article Pages

Reference - Icons

Markdown Basic Formatting