Hugo theme: dev

A Hugo theme for exampleSite content, component development, and testing. It is not a production-ready theme, but rather a sandbox for experimenting. It intentionally provides no styling.

Feel free to use it to explore, debug, and contribute new components!

Table of contents

• Demo
• Installation and usage
• Configuration
• Compatibility
• Contributing
• Licensing, copyright
• Author information

Demo

Clone the repository and run the included example content (requires Hugo, Go, and Git):

git clone https://github.com/foundata/hugo-theme-dev.git
cd ./hugo-theme-dev
HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**"

Installation and usage

The theme is intended to be added as Hugo module in your exampleSite and sandbox projects. Simply add the following to your theme: configuration:

theme:
  - "golang.foundata.com/hugo-theme-dev"

Hugo automatically fetches and import theme module paths as Go/Hugo modules, so you do not need to list them under module.imports manually. Using modules requires Hugo, Go, and Git to be installed on your system.

Configuration

No additional configuration is required by default.

But the theme provides demo content in English and German, along with a built-in language switcher. If you don’t want to include German demo content in your examples, you can disable the language and/or the language navigation in your site configuration:

disableLanguages:
  - "de"

params:
  # Theme-specific features and parameters.
  # All have sensible defaults, so you don't need to define them unless you
  # want to override the behavior globally or per page (via front matter).
  feature:
    langNav: false # default: true

There is also a built-in debugging feature, which dumps .Page, .Params and .Site.Params in the footer:

params:
  feature:
    debug: true # default: false

Every feature can also be controlled per page via front matter:

---
title: "Demo homepage"
feature:
  pagesNav: false
  langNav: false
  debug: false
---

Compatibility

This project is compatible with Hugo (extended) ≥ v0.148.0 and should always work with the latest Hugo release (we usually run the latest Hugo ourselves and fix issues promptly). It has been tested at least with:

• Hugo extended v0.149.0
• Hugo extended v0.148.0

If your version isn't listed, it might still work. Just give it a try.

Contributing

See CONTRIBUTING.md if you want to get involved.

This projects's functionality is mature, so there might be little activity on the repository in the future. Don't get fooled by this, the project is under active maintenance and used daily by the maintainers.

Licensing, copyright

Copyright (c) 2025 foundata GmbH (https://foundata.com)

This project is licensed under the GNU General Public License v3.0 or later (SPDX-License-Identifier: GPL-3.0-or-later), see LICENSES/GPL-3.0-or-later.txt for the full text.

The REUSE.toml file provides detailed licensing and copyright information in a human- and machine-readable format. This includes parts that may be subject to different licensing or usage terms, such as third-party components. The repository conforms to the REUSE specification. You can use reuse spdx to create a SPDX software bill of materials (SBOM).

Author information

This project was created and is maintained by foundata.