eclipsefdn-hugo-solstice-theme 3.0.1 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # eclipsefdn-hugo-solstice-theme
 
+## 3.1.0
+
+### Minor Changes
+
+- 2e7f59d: [Params] Add support for an array of styles & scripts with ESM support in site config
+
 ## 3.0.1
 
 ### Patch Changes

package/exampleSite/config/_default/config.toml

@@ -15,8 +15,6 @@ baseURL = "https://webdev.eclipse.org/docs/hugo"
   keywords = ["hugo", "solstice", "eclipse foundation"]
 #  logo = "images/logo/eclipse-foundation-white.svg"
 #  favicon = "images/favicon.ico"
-  styles = "css/neptune.css"
-  js = "js/neptune.js"
   gcse = "011805775785170369411:p3ec0igo0qq"
   gcse_result_url = "/search"
   # eclipse_search_icon = "<i data-feather=\"search\" stroke-width=\"1\"></i>"
@@ -60,3 +58,11 @@ baseURL = "https://webdev.eclipse.org/docs/hugo"
 [blackfriday]
   plainIDAnchors = true
   hrefTargetBlank = true
+
+[[Params.styles]]
+  url = "css/neptune.css"
+  cache = true
+
+[[Params.scripts]]
+  url = "js/neptune.js"
+  cache = true

package/exampleSite/data/doc_params.yml

@@ -93,6 +93,29 @@ items:
     values:
       - "true"
     ref: /components/featured_footer/
+  - name: scripts
+    description: Array of script objects to load on the page, rendered after site-level scripts. Each entry can define a type, url, cache, defer, and integrity.
+    values:
+      - "Array of objects with the following properties: url (string, required), type (string, e.g. module), cache (boolean, appends ?v=timestamp to bust cache), defer (boolean), integrity (string)"
+    example: |
+      scripts:
+        - type: "module"
+          url: "/js/page-specific.mjs"
+          cache: true
+  - name: styles
+    description: Array of stylesheet objects to load on the page, rendered after site-level styles. Replaces the deprecated page_css_file param.
+    values:
+      - "Array of objects with the following properties: url (string, required), cache (boolean, appends ?v=timestamp to bust cache)"
+    example: |
+      styles:
+        - url: "/css/page-specific.css"
+          cache: true
+  -
+    name: page_css_file
+    deprecated: true
+    description: "Deprecated: use the page-level styles array instead. URL to an additional stylesheet to load on this page."
+    values:
+      - Absolute links or fully qualified URLs.
   -
     name: Summary
     description: Built in Hugo document parameter. Used in the head meta description if the Description parameter is not set.

package/exampleSite/data/site_params.yml

@@ -70,7 +70,8 @@ items:
       - "true"
   -
     name: js
-    description: 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 <a href="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/main.min.js">main.min.js</a>
+    deprecated: true
+    description: "Deprecated: use [[Params.scripts]] array instead. URL to the main javascript to be used on the site. Defaults to <a href=\"https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/main.min.js\">main.min.js</a>"
     values:
       - Absolute link or fully qualified URL to a JS file
   - 
@@ -99,11 +100,22 @@ items:
     description:  Boolean value, when set to true events will be enabled on the site.
     values:
       - "true"
-  - 
+  -
     name: styles
-    description: 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 <a href="https://eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/quicksilver.min.css">quicksilver.min.css</a>
+    description: Array of stylesheet objects to load site-wide. Each entry supports url and cache (appends ?v=timestamp). Page-level styles are always appended after site styles. Defaults to the Neptune stylesheet.
     values:
-      - Absolute link or fully qualified URL to a CSS file
+      - "Array of objects with the following properties: url (string, required), cache (boolean, appends ?v=timestamp to bust cache)"
+    deprecated_values:
+      - "Deprecated string form: a single URL string — use [[Params.styles]] array instead. The legacy style_overrides string param is also deprecated in favour of adding additional entries to this array."
+    example: |
+      <pre>
+      [[Params.styles]]
+        url = "/css/main.css"
+        cache = true
+
+      [[Params.styles]]
+        url = "/css/overrides.css"
+      </pre>
   -
     name: hide_breadcrumb
     description: Hides the breadcrumb on all pages if set to true, otherwise ignored.
@@ -119,6 +131,28 @@ items:
     description: Optional custom_jumbotron_class that will be used for custom_jumbotron.
     values:
       - Any string value
+  -
+    name: newsroom_esm
+    description: When set to true, the inline newsroom components script (events, news items) is rendered as an ES module using `import $ from "jquery"`. Defaults to false.
+    values:
+      - "true"
+      - "false"
+  - name: scripts
+    description: Array of script objects to load site-wide. Each entry can define a type, url, cache, defer, and integrity. When defined, this replaces the js and hugo_js params.
+    values:
+      - "Array of objects with the following properties: url (string, required), type (string, e.g. module), cache (boolean, appends ?v=timestamp to bust cache), defer (boolean), integrity (string)"
+    example: |
+      <pre>
+      [[Params.scripts]]
+        type = "module"
+        url = "/js/main.mjs"
+        cache = true
+
+      [[Params.scripts]]
+        defer = true
+        url = "https://some.cdn.com/js/script.js"
+        integrity = "sha384-..."
+      </pre>
   - name: socials
     values:
       - "Array of objects with the following properties: name (string), icon (string, Font Awesome 6 icon classes), url (string)"

package/layouts/partials/footer_js.html

@@ -1,13 +1,39 @@
 <div id="footer-js">
   <!-- Placed at the end of the document so the pages load faster -->
   {{- $default_js := "https://www.eclipse.org/public/js/neptune/main.js" -}}
-  {{- with .Site.Params.js | default $default_js }}
-  <script src="{{ . | relURL }}?v={{ now.Unix }}"></script>
-  {{ end }}
+  {{- $site_scripts := .Site.Params.scripts -}}
+  {{- $page_scripts := .Page.Params.scripts -}}
 
-  {{- with .Site.Params.hugo_js }}
+  {{- if $site_scripts -}}
+    {{- range $site_scripts -}}
+      {{- $src := .url | relURL -}}
+      {{- if .cache -}}{{- $src = printf "%s?v=%d" $src now.Unix -}}{{- end -}}
+      {{- $stag := printf `<script src="%s"` $src -}}
+      {{- with .type -}}{{- $stag = printf `%s type="%s"` $stag . -}}{{- end -}}
+      {{- if .defer -}}{{- $stag = printf "%s defer" $stag -}}{{- end -}}
+      {{- with .integrity -}}{{- $stag = printf `%s integrity="%s"` $stag . -}}{{- end -}}
+      {{- (printf "%s></script>" $stag) | safeHTML -}}
+    {{- end }}
+  {{- else if .Site.Params.js -}}
+    {{- warnf "Param 'Params.js' is deprecated. Use [[Params.scripts]] array instead. See https://webdev.eclipse.org/docs/hugo/" -}}
+    <script src="{{ .Site.Params.js | relURL }}?v={{ now.Unix }}"></script>
+    {{- with .Site.Params.hugo_js }}
+    {{- warnf "Param 'Params.hugo_js' is deprecated. Use [[Params.scripts]] array instead. See https://webdev.eclipse.org/docs/hugo/" -}}
     <script src="{{ . | relURL }}"></script>
-  {{ end }}
+    {{- end }}
+  {{- else -}}
+    <script src="{{ $default_js | relURL }}?v={{ now.Unix }}"></script>
+  {{- end }}
+
+  {{- range $page_scripts -}}
+    {{- $src := .url | relURL -}}
+    {{- if .cache -}}{{- $src = printf "%s?v=%d" $src now.Unix -}}{{- end -}}
+    {{- $stag := printf `<script src="%s"` $src -}}
+    {{- with .type -}}{{- $stag = printf `%s type="%s"` $stag . -}}{{- end -}}
+    {{- if .defer -}}{{- $stag = printf "%s defer" $stag -}}{{- end -}}
+    {{- with .integrity -}}{{- $stag = printf `%s integrity="%s"` $stag . -}}{{- end -}}
+    {{- (printf "%s></script>" $stag) | safeHTML -}}
+  {{- end }}
 
   <!-- Read in mustache templates registered in page scratch -->
   {{ range $key, $value := (.Page.Scratch.Get "mustache-templates") }}
@@ -17,6 +43,21 @@
   {{ end }}
 
   <!-- Initialize any newsroom components on the page -->
+  {{ if (.Site.Params.newsroom_esm | default false) -}}
+  <script type="module">
+    import $ from "jquery";
+    {{ range (.Page.Scratch.Get "events-container-ids") }}
+      $("#{{ . }}").eclipseFdnApi({
+        type: "filteredEvents"
+      });
+    {{ end }}
+    {{ range (.Page.Scratch.Get "news-container-ids") }}
+      $("#{{ . }}").eclipseFdnApi({
+        type: "newsItems"
+      });
+    {{ end }}
+  </script>
+  {{- else -}}
   <script>
   (function($, document) {
     {{ range (.Page.Scratch.Get "events-container-ids") }}
@@ -31,6 +72,7 @@
     {{ end }}
   })(jQuery, document);
   </script>
+  {{- end }}
 
   {{ if eq (.Page.Scratch.Get "is_using_twitter") "true" }}
     <script src="https://platform.twitter.com/widgets.js" async></script>

package/layouts/partials/head.html

@@ -10,9 +10,9 @@
 
   SPDX-License-Identifier: EPL-2.0
 -->
-<meta charset="utf-8">
-<meta http-equiv="X-UA-Compatible" content="IE=edge">
-<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta charset="utf-8" />
+<meta http-equiv="X-UA-Compatible" content="IE=edge" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
 <!-- Site Title, Description, Author, and Favicon -->
 {{ $title :=  .Params.seo_title | default (.Params.headline | plainify) | default (.Title | plainify) | default .Site.Title }}
 {{ if (.Params.format_seo_title | default true) }}
@@ -25,46 +25,53 @@
 {{ $full_title := printf "%s%s" $title $title_suffix }}
 <title>{{ $full_title }}</title>
 <meta property="og:title" content="{{ $full_title }}" />
-<meta name="twitter:title" content="{{ $title | truncate 70 }}{{ $title_suffix }}" />
+<meta
+  name="twitter:title"
+  content="{{ $title | truncate 70 }}{{ $title_suffix }}"
+/>
 {{ if isset .Page.Params "redirect_url" }}
-<link rel="canonical" href="{{ .Page.Params.redirect_url }}"/>
-<meta name="robots" content="noindex">
-<meta http-equiv="refresh" content="0; url={{ .Page.Params.redirect_url }}" />
+  <link rel="canonical" href="{{ .Page.Params.redirect_url }}" />
+  <meta name="robots" content="noindex" />
+  <meta http-equiv="refresh" content="0; url={{ .Page.Params.redirect_url }}" />
 {{ end }}
 {{- with .Description | default .Page.Params.summary | default .Site.Params.description | plainify }}
-{{- with  . | replaceRE "{{[\\s\\S]*?}}" " " | truncate 160 }}
-<meta name="description" content="{{ . }}">
-<meta property="og:description" content="{{ . }}">
-<meta name="twitter:description" content="{{ . }}">
-{{- end }}
+  {{- $description_clean_pattern := "{{[\\s\\S]*? }}\\s*" -}}
+  {{- with . | replaceRE $description_clean_pattern " " | truncate 160 }}
+    <meta name="description" content="{{ . }}" />
+    <meta property="og:description" content="{{ . }}" />
+    <meta name="twitter:description" content="{{ . }}" />
+  {{- end }}
 {{- end }}
 {{- with .Page.Params.author }}
-<meta name="author" content="{{ . }}"/>
+  <meta name="author" content="{{ . }}" />
 {{- end }}
- {{- with  .Params.page_favicon | default .Site.Params.favicon | default "https://www.eclipse.org/favicon.ico"}}
-<link href='{{ . | relURL }}' rel='icon' type='image/x-icon'/>
+{{- with  .Params.page_favicon | default .Site.Params.favicon | default "https://www.eclipse.org/favicon.ico" }}
+  <link href="{{ . | relURL }}" rel="icon" type="image/x-icon" />
 {{- end -}}
 {{- with .Page.Params.metatag_robots }}
-  <meta name="robots" content="{{ . }}">
+  <meta name="robots" content="{{ . }}" />
 {{- end }}
 <!-- Social Media Tags -->
 {{- with .Params.share_img | default .Params.image  | default .Site.Params.share_img | default .Site.Params.logo }}
-<meta property="og:image" content="{{ . | absURL }}" />
-<meta name="twitter:image" content="{{ . | absURL }}" />
+  <meta property="og:image" content="{{ . | absURL }}" />
+  <meta name="twitter:image" content="{{ . | absURL }}" />
 {{- end }}
 <meta name="twitter:card" content="summary" />
 {{- with .Site.Params.author.twitter }}
-<meta name="twitter:site" content="@{{ . }}" />
-<meta name="twitter:creator" content="@{{ . }}" />
+  <meta name="twitter:site" content="@{{ . }}" />
+  <meta name="twitter:creator" content="@{{ . }}" />
 {{- end }}
 {{- with .Site.Params.fb_app_id }}
-<meta property="fb:app_id" content="{{ . }}" />
+  <meta property="fb:app_id" content="{{ . }}" />
 {{- end }}
 <meta property="og:url" content="{{ .Permalink | absLangURL }}" />
 <meta property="og:type" content="website" />
 <meta property="og:site_name" content="{{ .Site.Title }}" />
 {{- with .Keywords | default .Site.Params.keywords }}
-<meta name="keywords" content="{{ range $i, $e := . }}{{ if $i }}, {{ end }}{{ $e }}{{ end }}">
+  <meta
+    name="keywords"
+    content="{{ range $i, $e := . }}{{ if $i }},{{ end }}{{ $e }}{{ end }}"
+  />
 {{ end }}
 <!-- Hugo Version number -->
 {{ hugo.Generator -}}
@@ -72,33 +79,66 @@
 {{ $canonical_url := (.Page.Params.canonical_url | default .Permalink) | absLangURL }}
 <link rel="canonical" href="{{ $canonical_url }}" />
 {{ with .OutputFormats.Get "RSS" }}
-<link rel="alternate" href="{{ .RelPermalink }}" type="application/rss+xml" title="">
+  <link
+    rel="alternate"
+    href="{{ .RelPermalink }}"
+    type="application/rss+xml"
+    title=""
+  />
 {{ end }}
 {{ if ne .Page.Params.disable_css "true" }}
-{{- $default_css := "https://www.eclipse.org/public/css/neptune.css" -}}
-{{- with .Site.Params.styles | default $default_css }}
-<link rel="stylesheet" href="{{ . | relURL }}?v={{ now.Unix }}">
-{{- end }}
-{{- with .Site.Params.style_overrides }}
-<link rel="stylesheet" href="{{ . | relURL }}?v={{ now.Unix }}">
-{{- end }}
-{{- with .Page.Params.page_css_file }}
-<link rel="stylesheet" href="{{ . | relURL }}?v={{ now.Unix }}">
-{{- end }}
+  {{- $default_css := "https://www.eclipse.org/public/css/neptune.css" -}}
+  {{- $site_styles := .Site.Params.styles -}}
+  {{- $page_styles := .Page.Params.styles -}}
+
+  {{- if $site_styles -}}
+    {{- range $site_styles -}}
+      {{- $href := .url | relURL -}}
+      {{- if .cache -}}
+        {{- $href = printf "%s?v=%d" $href now.Unix -}}
+      {{- end -}}
+      <link rel="stylesheet" href="{{ $href }}" />
+    {{- end }}
+  {{- else if .Site.Params.styles -}}
+    {{- warnf "Param 'Params.styles' is deprecated. Use [[Params.styles]] array instead. See https://webdev.eclipse.org/docs/hugo/" -}}
+    <link rel="stylesheet" href="{{ .Site.Params.styles | relURL }}?v={{ now.Unix }}" />
+    {{- with .Site.Params.style_overrides }}
+    {{- warnf "Param 'Params.style_overrides' is deprecated. Use [[Params.styles]] array instead. See https://webdev.eclipse.org/docs/hugo/" -}}
+    <link rel="stylesheet" href="{{ . | relURL }}?v={{ now.Unix }}" />
+    {{- end }}
+  {{- else -}}
+    <link
+      rel="stylesheet"
+      href="{{ $default_css | relURL }}?v={{ now.Unix }}"
+    />
+  {{- end }}
+
+  {{- range $page_styles -}}
+    {{- $href := .url | relURL -}}
+    {{- if .cache -}}{{- $href = printf "%s?v=%d" $href now.Unix -}}{{- end -}}
+    <link rel="stylesheet" href="{{ $href }}" />
+  {{- end }}
+
+  {{- if not $page_styles -}}
+    {{- with .Page.Params.page_css_file }}
+    {{- warnf "Page param 'page_css_file' is deprecated. Use the page-level styles array instead. See https://webdev.eclipse.org/docs/hugo/" -}}
+    <link rel="stylesheet" href="{{ . | relURL }}?v={{ now.Unix }}" />
+    {{- end }}
+  {{- end }}
 {{- end }}
 {{- partial "google_tag_manager.html" . }}
 {{- partial "head_variables.html" . }}
 
 {{ $metadata := .Page.Params.metadata | default slice }}
 {{ range $metadata }}
-    {{ $path_parts := split .path "/" }}
-    {{ $data := $.Site.Data }}
-    {{ range $path_parts }}
+  {{ $path_parts := split .path "/" }}
+  {{ $data := $.Site.Data }}
+  {{ range $path_parts }}
     {{ $data = index $data . }}
   {{ end }}
   {{ if eq .type "ld+json" }}
     <script type="application/ld+json">
-      {{ with $data }} 
+      {{ with $data }}
         {{ . }}
       {{ end }}
     </script>

package/package.json

@@ -4,7 +4,7 @@
   "main": "webpack.min.js",
   "author": "Christopher Guindon",
   "license": "EPL-2.0",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "bugs": {
     "url": "https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-solstice-theme/-/issues"
   },