Hugo Solstice theme
This site contains information about the Hugo Solstice theme used on Eclipse Foundation sites, a styleguide describing usage and showing some sample pages for list content. Information about each of the base components, how they are used, and some visible samples for how content appears at different breakpoints can be seen on the component styleguide. The pages showing this functionality can also be accessed through the Components section in the header navigation.
The Hugo Solstice theme project is available under the Eclipse Public License, version 2, on GitHub. Currently the project is maintained by the in-house web development team, but like other projects under the Eclipse Foundation umbrella is open to community input and development.
Document Parameters
Following section describes the parameters optionally set within each of the pages within the site. These will always override parameters of the same name present in the site parameters section.
| Parameter name | Description |
|---|---|
| author | Author name of the blog. This will be used to set the author of a blog. Accepted values:
|
| body_class | Add classes to the body element. Accepted values:
|
| container | If set, replaces the default container class of "container" with what is set in the parameter. Accepted values:
|
| custom_jumbotron | Optional custom_jumbotron that will be inserted after taglines, can include html tags. We recommend to not use taglines and custom_jumbotron at the same time. Accepted values:
|
| custom_jumbotron_class | Optional custom_jumbotron_class that will be used for custom_jumbotron. Accepted values:
|
| Description | Built in Hugo document parameter. Used in the head meta description as the primary value if set. Accepted values:
|
| disable_css | Disables CSS on the given page if set to "true", otherwise is ignored. Accepted values:
|
Email address of the author of the blog. This will be used to set the email of a blog. If not set, site email will be used and if this is not set, "no+reply@eclipse-foundation.org" will be used as the email. Accepted values:
Example: example@domain.com | |
| format_title | Formats the page title in headings and breadcrumbs to title case. If there is no value set, will default to true. Accepted values:
|
| header_wrapper_class | Used in the header.html layout file, being appended to the header-wrapper class to optionally change or add to the header classes used on the page. Accepted values:
|
| headline | If set, will render a jumbotron in the header with the given text as the headline of the content. Also used in the title meta tag when seo_title is missing from the page parameters. Accepted values:
|
| hide_breadcrumb | Hides the page breadcrumb if set to true, otherwise ignored. Accepted values:
|
| hide_call_for_action | Hides the CFA button on the page. Accepted values:
|
| hide_page_title | Hides the page title if set to true, otherwise ignored. Accepted values:
|
| hide_sidebar | Hides the main content sidebar if set to true, otherwise ignored. Accepted values:
|
| image | URL for an image that will be used on the page for TODO. Used in fallback scenarios for sharing thumbnail when share_img is not set for the page. Accepted values:
|
| keywords | Keywords to use in the head of the page, used in metadata tagging. Accepted values:
Example: ["tag1", "tag2", "tag3"] |
| links | Optional set of links that will be included under the tagline in the jumbotron as buttons, with the text as the anchors of the buttons. Accepted values:
Example: [[href: "about/", text: "About"], [href: "news/", text: "News"]] |
| main_menu | Replaces the default main menu for one defined in config.toml or menus.toml. See more information here. Accepted values:
|
| redirect_url | Set the redirect URL for client-side page forwarding. Used in the head.html layout file, and is used in the canonical URL, and in an instant refresh meta tag for page target. If set, it will also set the page to not be indexed in the future by robots. Accepted values:
|
| seo_title | The Search Engine Optimized (SEO) title of the page. This will be used as the site title in the metadata, along with the site SEO suffix. Accepted values:
|
| share_img | Image URL source used for thumbnails when shared via Twitter. Accepted values:
|
| show_collapsible_menu | Show collapsible menu for mobile view on this page if set to true, otherwise is ignored. Accepted values:
|
| show_featured_footer | Shows the featured footer section at the top of the page if set to true, otherwise is ignored. Accepted values:
Reference: Document reference |
| show_featured_story | Shows the featured story section at the top of the page if set to true, otherwise is ignored. Accepted values:
Reference: Document reference |
| sidebar | Target specific menu identifiers. Used when a page or sub-section uses different sidebar content than the rest of the section it's in. Each identifier must have a corresponding "menu.sidebar" entry in the site's "config" file. If this parameter is omitted, the default sidebar for the section is used. Accepted values:
|
| subtitle | Used in the jumbotron, set in a second level header under the headline. Ignored if headline is not set. Accepted values:
|
| Summary | Built in Hugo document parameter. Used in the head meta description if the Description parameter is not set. Accepted values:
|
| tagline | Optional tagline that will be inserted after the subtitle parameter in the jumbotron as the tagline under the titles for the page. Accepted values:
|
Site Parameters
Following section describes the parameters set within the sites config.toml file, rather than parameters set at the page level.
| Parameter name | Description |
|---|---|
| bluesky_url | URL to the Bluesky page for the site. If there is no value set, will default to Eclispe Foundation page. Deprecated in v0.1.7 Accepted values:
|
| call_for_action_icon | Icon class for the navbar CTA button. The icons used in Solstice are from Font Awesome, and any icon name should be prepended by 'fa-'. Accepted values:
Example: fa-github |
| call_for_action_text | The text for the CTA button in the navbar Accepted values:
|
| call_for_action_url | The anchor URL for the CTA button in the navbar. Accepted values:
|
| custom_jumbotron_class | Optional custom_jumbotron_class that will be used for custom_jumbotron. Accepted values:
|
| description | Description of the overall site, used in a pages meta description if no page level description is set. Accepted values:
|
| facebook_url | URL to the Facebook page for the site. If there is no value set, will default to Eclispe Foundation page. Deprecated in v0.1.7 Accepted values:
|
| favicon | URL to the favicon image for the site. Accepted values:
|
| fb_app_id | The Facebook application ID string for the sites ad network account. Accepted values:
|
| gcse | The Google site search collection ID string. Accepted values:
|
| google_tag_manager | If set, the Google tag manager is activated in the footer. Accepted values:
|
| header_wrapper_class | Used in the header.html layout file, being appended to the header-wrapper class to optionally change or add to the header classes used on the page. Only used if not set at the page level. Accepted values:
|
| hide_breadcrumb | Hides the breadcrumb on all pages if set to true, otherwise ignored. Accepted values:
|
| hide_call_for_action | Hides the CFA button site-wide. |
| hide_cfa_same_page | Attempt to hide CFA on the page it links to Accepted values:
|
| js | URL to the main javascript to be used on the site. This does not affect any scripts added in custom sctions of the site. Defaults to main.min.js Accepted values:
|
| jumbotron_btn_class | Used in the jumbotron.html layout file. Allow you to change the default value of btn btn-primary. Can be set at the site or page level. Accepted values:
|
| jumbotron_class | Used in the jumbotron.html layout file. Allow you to change the default value of col-md-20 col-md-offset-2 col-sm-18 col-sm-offset-3. Can be set at the site or page level. Accepted values:
|
| jumbotron_tagline_class | Used in the jumbotron.html layout file. Allow you to change the default value of col-sm-18 col-sm-offset-3. Can be set at the site or page level. Accepted values:
|
| keywords | Keywords to use in the head of the page, used in metadata tagging. Used if the keywords param is not set at the page level. Accepted values:
Example: ["tag1", "tag2", "tag3"] |
| linkedin_url | URL to the linkedin page for the site. If there is no value set, will default to Eclispe Foundation page. Deprecated in v0.1.7 Accepted values:
|
| logo | URL to the logo image for the site. If there is no other image set in page or site parameters, this image is used as the sharing image for social media links. Accepted values:
|
| main_content_class | Used in the main_prefix.html layout file. Allow you to change the default value of col-md-18 padding-bottom-30 is overriten. Can be set at the site or page level. Accepted values:
|
| main_sidebar_class | Used in the main_suffix.html layout file. Allow you to change the default value of col-md-6 padding-bottom-30. Can be set at the site or page level. Accepted values:
|
| seo_title_suffix | If set, this value is appended to the page title in the head of the page for the meta title. Accepted values:
|
| share_img | URL to the image used for sharing links for the site. If there is no other image set in page or site parameters, this image is used as the sharing image for social media links. Accepted values:
|
| show_collapsible_menu | Show collapsible menu for mobile view on all pages if set to true, otherwise is ignored. Accepted values:
|
| show_events | Boolean value, when set to true events will be enabled on the site. Accepted values:
|
| socials | Accepted values:
Example: [[Params.socials]] name = "Bluesky" icon = "fa-brands fa-bluesky" url = "https://bsky.app/profile/eclipsefdn.bsky.social" |
| styles | URL to the stylesheet to be used on the site. This does not affect any stylesheets added in custom sctions of the site. Defaults to quicksilver.min.css Accepted values:
|
| twitter_url | URL to the Twitter page for the site. If there is no value set, will default to Eclispe Foundation page. Deprecated in v0.1.7 Accepted values:
|
| youtube_url | URL to the YouTube page for the site. If there is no value set, will default to Eclispe Foundation page. Deprecated in v0.1.7 Accepted values:
|