Site Configuration

noreply@example.com (AG Sayyed) — Sun, 13 Apr 2025 21:13:46 +0000

A comprehensive guide to configuring your HBStack-based Hugo site. Learn to set up hugo.yaml, manage parameters, and optimize site settings for production.

Understanding the Hugo Configuration File

The primary configuration for your HBStack site is managed through the config/_default/hugo.yaml file. This file contains essential settings that control how your site functions, its appearance, and various technical aspects of Hugo’s behavior.

Basic Site Settings

1baseURL: https://theme.hbstack.dev/
2title: HB Starter Theme Template
3copyright: 'Copyright © 2022-{year} [Hugo Modules](https://hugomods.com/) and [HB Framework](https://hbstack.dev/). All Rights Reserved.'

baseURL: This is the root URL where your site will be published. Change this to your domain (e.g., https://yourdomain.com/).
title: The name of your site that appears in the browser tab and is used throughout the site. Customize this to your project name.
copyright: The copyright notice shown in the footer. Note the {year} placeholder is automatically replaced with the current year.

Changed Settings for the Project

1baseURL: https://agsayyed.github.io/hugo-with-docker/
2title: Hugo With Docker
3# Copyright, the {year} is the placeholder of this year.
4copyright: 'Copyright © 2024-{year} AG Sayyed. All Rights Reserved.'

Language Settings

1defaultContentLanguage: en
2defaultContentLanguageInSubdir: true

defaultContentLanguage: Sets the default language for your site (currently “en” for English).
defaultContentLanguageInSubdir: When set to true, adds the language code to URLs (e.g., /en/docs/). Set to false to remove language codes from URLs.

Site Features and Behavior

1enableRobotsTXT: true
2timeout: 120s
3enableEmoji: true
4
5title_sections: true
6title_sections_depth: 0
7title_sections_depth_dir: end

enableRobotsTXT: Generates a robots.txt file for search engine crawlers.
timeout: Sets the build timeout (120 seconds) - useful for sites with complex image processing.
enableEmoji: Allows emoji shortcodes in your content (e.g., :smile: → 😄).
title_sections: Controls whether section names appear in page titles.
title_sections_depth and title_sections_depth_dir: Control how deep section names go in titles.

URL Structure

1permalinks:
2 blog: /blog/:year/:month/:title

permalinks: Defines URL patterns for different content types. Modify this section to customize URL structures for your content.

Output Formats

1outputs:
2 home:
3 - HTML
4 - Offline
5 - RSS
6 - SearchIndex
7 - WebAppManifest

This section defines what output formats are generated. The current configuration supports:
- Standard HTML pages
- Offline pages (for PWA support)
- RSS feeds
- Search index (for site search functionality)
- Web App Manifest (for PWA installation)

Taxonomy Configuration

1taxonomies:
2 authors: authors
3 tags: tags
4 categories: categories
5 series: series

taxonomies: Defines how content is categorized. You can modify this section to add, remove, or rename taxonomies according to your organizational needs.

Build Settings

1build:
2 writeStats: true

writeStats: Required for PurgeCSS to optimize CSS files. Leave this enabled for better performance.

Markdown Rendering

1markup:
2 goldmark:
3 renderer:
4 unsafe: true
5 highlight:
6 noClasses: false
7 lineNos: true
8 lineNumbersInTable: false

goldmark.renderer.unsafe: When set to true, allows raw HTML in Markdown files.
highlight: Controls code syntax highlighting:
- noClasses: When false, uses CSS classes for styling.
- lineNos: Enables line numbers in code blocks.
- lineNumbersInTable: When false, shows line numbers inline rather than in a table format.

 1related:
 2 includeNewer: true
 3 indices:
 4 - name: keywords
 5 weight: 100
 6 - name: tags
 7 weight: 80
 8 # Additional indices...
 9 threshold: 10
10 toLower: false

This section controls how related content suggestions work:
- includeNewer: When true, newer posts can be suggested as related to older ones.
- indices: Lists factors for determining relatedness, with higher weights having more influence.
- threshold: Minimum score needed to include a page in related content.

Security Settings

1security:
2 funcs:
3 getenv:
4 - ^HUGO
5 - CI$
6 - PWD

Controls which environment variables can be accessed by Hugo templates for security purposes.

Development Environment Configuration

Hugo allows for environment-specific configuration using separate files. For local development, the project uses a specific configuration located at config/development/hugo.yaml:

Site-Settings on Ghafoor's Personal Blog