Front Matter on Hugo Solstice Theme

author

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

author: "Jane Doe"

body_class

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

body_class: "eclipse-404 solstice-no-padding"

breadcrumb_title

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

breadcrumb_title: "Getting Started"

container

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

container: "container-fluid"

custom_jumbotron

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

custom_jumbotron: |
 <h1 class="margin-top-10">Guiding the Future of IDE Development</h1>
 <p class="margin-top-20">May 19, 2025 &mdash; 8AM–11AM PST</p>

custom_jumbotron_class

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

custom_jumbotron_class: "jumbotron-custom-event"

description

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

Description: "Learn how to configure the Hugo Solstice theme for your Eclipse Foundation site."

disable_css

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

When not set (or set to any value other than true), the parameter is ignored and CSS loads normally.

Example

disable_css: true

email

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

email: "author@example.org"

header_wrapper_class

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

header_wrapper_class: "header-default-bg-img"

headline

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

headline: "Eclipse IoT"

hide_breadcrumb

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

When not set (or set to any value other than true), the breadcrumb is shown normally (unless hidden at the site level).

Example

hide_breadcrumb: true

hide_call_for_action

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

When not set (or set to any value other than true), the parameter is ignored and the CTA button is shown normally (unless hidden at the site level via hide_call_for_action in config.toml).

Example

hide_call_for_action: true

hide_page_title

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

When not set (or set to any value other than true), the page title is shown normally.

Example

hide_page_title: true

hide_sidebar

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

When not set (or set to any value other than true), the sidebar is rendered normally.

Example

hide_sidebar: true

image

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

image: "/images/og-default.jpg"

keywords

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

keywords:
 - "eclipse"
 - "iot"
 - "open source"

links

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

links:
 - href: "/about/"
 text: "About"
 - href: "/downloads/"
 text: "Download"
 class: "btn btn-primary"
 id: "download-btn"

main_menu

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

If main_menu is not set, the default main menu is used.

Use the front matter cascade to apply the custom menu to all pages in a section.

Example

Define a custom menu in menus.toml:

[[my_event_menu]]
 name = "Home"
 url = "/my-event-2025/"
 weight = 1

[[my_event_menu]]
 name = "Schedule"
 url = "/my-event-2025/schedule/"
 weight = 2

Then reference it from the section _index.md:

---
title: "My Event 2025"
cascade:
 main_menu: "my_event_menu"
---

page_css_file

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Use the styles parameter instead, which supports cache-busting and loading multiple stylesheets.

Example (deprecated usage)

page_css_file: "/css/my-page.css"

Replacement

styles:
 - url: "/css/my-page.css"
 cache: true

redirect_url

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

redirect_url: "/docs/new-location/"

scripts

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

scripts:
 - url: "/js/page-specific.mjs"
 type: "module"
 cache: true
 - url: "https://cdn.example.org/widget.js"
 defer: true
 integrity: "sha384-abc123..."

seo_title

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

When seo_title is not set, the page’s headline or title is used instead.

Example

seo_title: "Getting Started with Eclipse IoT"

share_img

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

When share_img is not set, the theme falls back to image, then to the site-level share_img, and finally to the site logo.

Example

share_img: "/images/my-announcement-share.jpg"

show_collapsible_menu

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

When not set (or set to any value other than true), the parameter is ignored. Can also be enabled site-wide via the show_collapsible_menu site parameter.

Example

show_collapsible_menu: true

show_featured_footer

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

When not set (or set to any value other than true), the featured footer is hidden on this page.

Example

show_featured_footer: true

sidebar

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

When sidebar is omitted, the default sidebar for the section is used.

Example

Define the menu in menus.toml:

[[sidebar]]
 identifier = "my-custom-sidebar"
 name = "My Project"
 url = "#"
 weight = 1

[[sidebar]]
 parent = "my-custom-sidebar"
 name = "Overview"
 url = "/my-project/"
 weight = 1

Then reference it in the page front matter:

sidebar:
 - "my-custom-sidebar"

styles

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Replaces the deprecated page_css_file parameter.

Example

styles:
 - url: "/css/page-specific.css"
 cache: true
 - url: "https://cdn.example.org/widget.css"

summary

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Hugo can also auto-generate the summary from the first paragraph of the page content if Summary is not explicitly set in the front matter. Use Description to take full control of the meta description.

Example

Summary: "A brief overview of the page content used in previews and meta tags."

tagline

webdev@eclipse-foundation.org (Christopher Guindon) — Mon, 01 Jan 0001 00:00:00 +0000

Example

tagline: "The open-source platform for IoT developers."