Merge pull request #363 from gethinode/develop

Add canonifyAssetsURLs option

.eslintignore

@@ -1,5 +1,5 @@
+assets/js/critical/color.js
 assets/js/analytics.js
-assets/js/color.js
 assets/js/flexsearch.js
 assets/js/vendor
 node_modules

README.md

@@ -56,10 +56,11 @@
 - [PageSpeed Insights][pagespeed]
 - [Mozilla Observatory][observatory]
 
-Hinode is a clean documentation and blog theme for [Hugo][hugo], an open-source static site generator. Based on the [Bootstrap 5][bootstrap] framework, the rendered site is fast, secure, and responsive. Hinode uses [FlexSearch][flexsearch] to enable full text search across your site. Finally, the theme uses [Node Package Manager][npm] to automate the build process and to keep track of dependencies.
+Hinode is a clean documentation and blog theme for [Hugo][hugo], an open-source static site generator. Based on the [Bootstrap 5][bootstrap] framework, the rendered site is fast, secure, and responsive. Hinode uses [FlexSearch][flexsearch] to enable full text search across your site. Finally, the theme supports [Node Package Manager][npm] to automate the build process and to keep track of dependencies.
 
 Additional features include:
 
+- Flexible configuration of Hugo modules
 - Switching between light mode and dark mode
 - Support for multiple languages
 - Reusable Bootstrap components through configurable shortcodes and partials

assets/js/critical/color.js

@@ -1,3 +1,5 @@
+{{- if site.Params.main.enableDarkMode -}}
+
 /*!
  * Color mode toggler for Bootstrap's docs (https://getbootstrap.com/)
  * Copyright 2011-2022 The Bootstrap Authors
@@ -68,3 +70,5 @@
       })
   })
 })()
+
+{{- end -}}

assets/scss/app.scss

@@ -5,10 +5,6 @@
 @import "common/variables.scss";
 @import "common/icons.scss";
 
-{{ if not (in site.Params.modules.core "bootstrap") }}
-    {{ errorf "Bootstrap is a required module, please add it to 'modules.core' in your site parameters" }}
-{{ end }}
-
 // Import Bootstrap configuration (mounted by core Bootstrap module)
 @import "bootstrap.scss";
 

assets/scss/components/_syntax.scss

@@ -10,6 +10,7 @@
 
 .syntax-highlight {
     background-color: var(--bs-light) if($enable-important-utilities, !important, null);
+    overflow-x: auto;
 }
 
 .preview-background {
@@ -29,6 +30,7 @@
 
         .syntax-highlight {
             background-color: var(--bs-tertiary-bg) if($enable-important-utilities, !important, null);
+            overflow-x: auto;
         }
 
         .bg,

config/_default/params.toml

@@ -4,6 +4,7 @@
     description = "Hinode is a clean documentation and blog theme for your Hugo site based on Bootstrap 5."
     enableDarkMode = true
     modes = ["light", "dark"]
+    canonifyAssetsURLs = false
 # toml-docs-end main
 
 # toml-docs-start modules

go.mod

@@ -4,7 +4,7 @@ go 1.19
 
 require (
 	github.com/gethinode/mod-bootstrap v1.1.0 // indirect
-	github.com/gethinode/mod-flexsearch v1.1.2 // indirect
+	github.com/gethinode/mod-flexsearch v1.1.4 // indirect
 	github.com/gethinode/mod-fontawesome v1.2.1 // indirect
 	github.com/gethinode/mod-katex v1.0.2 // indirect
 	github.com/gethinode/mod-leaflet v0.3.3 // indirect

go.sum

@@ -10,6 +10,10 @@ github.com/gethinode/mod-flexsearch v1.1.1 h1:zHypfKR/rWPAwqNXvo09Pp3vGqU4w3r7d2
 github.com/gethinode/mod-flexsearch v1.1.1/go.mod h1:TXbGbWsvmhBdsTzRt887mcpFfr4ORpzG3+h/l4W3YM4=
 github.com/gethinode/mod-flexsearch v1.1.2 h1:vA/jHxLq9xxkYGS9cmAoLNIkEBW+iLVCcQ8qKyEa+R4=
 github.com/gethinode/mod-flexsearch v1.1.2/go.mod h1:TXbGbWsvmhBdsTzRt887mcpFfr4ORpzG3+h/l4W3YM4=
+github.com/gethinode/mod-flexsearch v1.1.3 h1:lzmSvnJL6ABjp03avYzSvJJ7hw01CpHap1JGUbDIELg=
+github.com/gethinode/mod-flexsearch v1.1.3/go.mod h1:TXbGbWsvmhBdsTzRt887mcpFfr4ORpzG3+h/l4W3YM4=
+github.com/gethinode/mod-flexsearch v1.1.4 h1:dJvwBxYlLe/VGlctLn8k89STJ5toATIjNnXIlNeanOY=
+github.com/gethinode/mod-flexsearch v1.1.4/go.mod h1:TXbGbWsvmhBdsTzRt887mcpFfr4ORpzG3+h/l4W3YM4=
 github.com/gethinode/mod-fontawesome v1.0.2 h1:ZSK6D20/w4y5GnfYfTBB58uHD0ChIfkpKfRGwioS9rg=
 github.com/gethinode/mod-fontawesome v1.0.2/go.mod h1:Ki1qkWEOiF0hQpCgWeZRw+HkpL6nd1DxKFptU0O2feI=
 github.com/gethinode/mod-fontawesome v1.1.0 h1:rsDzUI+3ZlS/do2ff3ne8/z3KwHeysmuA+WsXlumXXk=

layouts/_default/baseof.html

@@ -12,6 +12,10 @@
     {{- end -}}
 {{- end -}}
 
+{{- if and .IsPage (not (in .Site.Params.modules.core "bootstrap")) -}}
+    {{- errorf "Bootstrap is a required module, please add it to 'modules.core' in your site parameters" -}}
+{{- end -}}
+
 <!doctype html>
 <html lang="{{ .Site.Language.Lang }}" class="no-js">
     <head>
@@ -19,9 +23,7 @@
     </head>
 
     <body>
-        {{- if site.Params.main.enableDarkMode -}}
         {{- partial "footer/scripts.html" (dict "filename" "js/critical.bundle.js" "match" "js/critical/**.js" "header" true "page" .) -}}
-        {{- end -}}
         <div class="d-flex flex-column min-vh-100{{ if and .IsHome .Site.Params.home.style }} {{ .Site.Params.home.style }}{{ end }}">
             <div class="{{ if .Site.Params.navigation.fixed }}mb-4{{ end }}">
                 {{- partial "assets/navbar.html" (dict

layouts/_default/single.html

@@ -67,7 +67,7 @@
                 {{ with .NextInSection -}}
                     {{ $next := . -}}
                     {{ with .OutputFormats.Get "html" -}}
-                        <a class="next" href="{{ $next.Permalink }}"><i class="fas fa-arrow-left"></i> {{ $next.Title }}</a>
+                        <a class="next" href="{{ $next.RelPermalink }}"><i class="fas fa-arrow-left"></i> {{ $next.Title }}</a>
                     {{- end -}}
                 {{ end -}}
             </div>
@@ -75,7 +75,7 @@
                 {{ with .PrevInSection -}}
                     {{ $prev := . -}}
                     {{ with .OutputFormats.Get "html" -}}
-                        <a class="previous" href="{{ $prev.Permalink }}">{{ $prev.Title }} <i class="fas fa-arrow-right"></i></a>
+                        <a class="previous" href="{{ $prev.RelPermalink }}">{{ $prev.Title }} <i class="fas fa-arrow-right"></i></a>
                     {{- end -}}
                 {{ end -}}
             </div>

layouts/_default/single.xml

@@ -7,10 +7,10 @@
 					{{ $square150 := .Resize "150x150 CatmullRom" }} 
 					{{ $wide310 := .Fill "310x150 CatmullRom" }} 
 					{{ $square310 := .Resize "310x310 CatmullRom" }}
-					<square70x70logo src="{{ $square70.Permalink }}" />
-					<square150x150logo src="{{ $square150.Permalink }}" />
-					<wide310x150logo src="{{ $wide310.Permalink }}" />
-					<square310x310logo src="{{ $square310.Permalink }}" />
+					<square70x70logo src="{{ $square70.RelPermalink }}" />
+					<square150x150logo src="{{ $square150.RelPermalink }}" />
+					<wide310x150logo src="{{ $wide310.RelPermalink }}" />
+					<square310x310logo src="{{ $square310.RelPermalink }}" />
 				{{ end }}
 				<TileColor>#000000</TileColor>
 			</tile>

layouts/partials/assets/breadcrumb.html

@@ -3,7 +3,7 @@
         {{- range $index, $item := .Page.Ancestors.Reverse -}}
             {{- $title := .Title -}}
             {{- if .IsHome }}{{ $title = T "home" }}{{ end -}} 
-            {{- $address := or .Permalink (.Params.Redirect | absLangURL) -}}
+            {{- $address := or .RelPermalink (.Params.Redirect | relLangURL) -}}
             {{ if $address }}
                 <li class="breadcrumb-item"><a href="{{ $address }}">{{ $title }}</a></li>
             {{ else }}

layouts/partials/assets/card-group.html

@@ -107,12 +107,12 @@
                 "orientation" $orientation
             ) -}}
             
-            {{- if $element.Permalink -}}
+            {{- if $element.RelPermalink -}}
                 {{- $params = merge $params (dict "path" $element.File.Path) -}}
             {{- else -}}
                 {{- $params = merge $params (dict
                     "title" $element.Title
-                    "href" $element.Permalink
+                    "href" $element.RelPermalink
                     "description" (or $element.Description $element.Content)
                     "thumbnail" $element.Params.thumbnail
                     "icon" $element.Params.icon

layouts/partials/assets/card.html

@@ -111,7 +111,7 @@
 
 {{- with $page -}}
     {{- if not $title }}{{ $title = .Title }}{{ end -}}
-    {{- if not $href }}{{ $href = .Permalink  }}{{ end -}}
+    {{- if not $href }}{{ $href = .RelPermalink  }}{{ end -}}
     {{- if not $description }}{{ $description = .Description }}{{ end -}}
     {{- if not $thumbnail }}{{ $thumbnail = .Params.thumbnail }}{{ end -}}
     {{- if not $icon }}{{ $icon = .Params.icon }}{{ end -}}

layouts/partials/assets/image.html

@@ -15,6 +15,7 @@
 -->
 
 {{- $validRatios := slice "1x1" "4x3" "16x9" "21x9" -}}
+{{- $absoluteURL := site.Params.main.canonifyAssetsURLs | default false -}}
 {{- $ratio := .ratio -}}
 {{- $url := .url -}}
 {{- $mode := false -}}
@@ -68,6 +69,7 @@
 
 <!-- Generate a image set of type webp -->
 {{- define "partials/image-scaled.html " -}}
+    {{- $absoluteURL := site.Params.main.canonifyAssetsURLs | default false -}}
     {{- $img := .img -}}
     {{- $ratio := .ratio -}}
     {{- $imgset := "" -}}
@@ -98,7 +100,11 @@
                 {{- $scaled = $img.Fit (printf "%s webp" $dim) -}}
             {{- end -}}
             {{- $scaled = $scaled | resources.Copy (replace $img.RelPermalink $clean (printf "-%s.webp" $dim)) -}}
+            {{- if $absoluteURL -}}
                 {{- $imgset = printf "%s, %s %sw" $imgset $scaled.Permalink (index $widths $index) -}}
+            {{- else -}}
+            {{- $imgset = printf "%s, %s %sw" $imgset $scaled.RelPermalink (index $widths $index) -}}
+            {{- end -}}
         {{- end -}}
         {{- $imgset = strings.TrimPrefix ", " $imgset -}}
     {{- end -}}
@@ -108,6 +114,7 @@
 
 <!-- Define the img with optional caption -->
 {{- define "partials/image-definition.html" -}}
+    {{- $absoluteURL := site.Params.main.canonifyAssetsURLs | default false -}}
     {{- $ratio := .ratio -}}
     {{- $url := .url -}}
     {{- $outerClass := .outerClass -}}
@@ -125,7 +132,11 @@
         {{- $img := partial "utilities/GetImage.html" (dict "url" $url) -}}
         {{- if $img -}}
             {{- $fallback := partial "partials/image-default.html" (dict "img" $img "ratio" $ratio) -}}
+                {{- if $absoluteURL -}}
+                    {{- $fallbackURL = $fallback.Permalink -}}
+                {{- else -}}
                     {{- $fallbackURL = $fallback.RelPermalink -}}
+                {{- end -}}
             {{- $imgset = partial "partials/image-scaled.html " (dict "img" $img "ratio" $ratio) -}}
         {{- end -}}
     {{- end -}}
@@ -145,7 +156,7 @@
                 srcset="{{ . }}"
                 sizes="100vw"
                 {{- end }}
-                src="{{ absURL $fallbackURL }}"
+                src="{{ $fallbackURL }}"
                 alt="{{ $title }}">
         </div>
     {{- if $caption -}}

layouts/partials/assets/navbar.html

@@ -93,6 +93,7 @@
     </li>
 {{- end -}}
 
+{{- $absoluteURL := site.Params.main.canonifyAssetsURLs | default false -}}
 {{- $supportedFlags := slice "true" "false" -}}
 
 {{- $id := printf "navbar-collapse-%d" 0 -}}
@@ -105,11 +106,14 @@
     {{- errorf "partial [assets/navbar.html] - Missing value for param 'page'" -}}
 {{- end -}}
 
-{{- $menuName := "main" }}
-{{- with .menus }}{{ $menuName = .}}{{ end -}}
+{{- $defaultMenu := "main" }}
+{{- $menuName := $defaultMenu }}
+{{- with .menus }}{{ $menuName = . }}{{ end -}}
 {{- $menus := index site.Menus $menuName -}}
 {{- if or (ne (printf "%T" $menus) "navigation.Menu") (ne (index $menus 0).Menu $menuName) -}}
+    {{- if ne $menuName $defaultMenu }}
         {{- errorf "partial [assets/navbar.html] - Invalid value for param 'menus': %s" $menuName -}}
+    {{- end -}}
 {{- end -}}
 
 {{- $size := "md" -}}
@@ -147,7 +151,7 @@
     {{- end -}}
 {{- end -}}
 
-{{- $enableDarkMode := default true site.Params.main.enableDarkMode -}}
+{{- $enableDarkMode := default false site.Params.main.enableDarkMode -}}
 {{- with .mode -}}
     {{- $darkModeParam := . -}}
     {{- if in $supportedFlags $darkModeParam -}}
@@ -202,7 +206,7 @@
             <!-- Insert the brand logo or name -->
             <a class="navbar-brand mx-auto" href="{{ site.Home.RelPermalink }}">
                 {{- if $logo -}}
-                    <img src="{{ $logo }}" alt="{{ $title }} logo" height="30">
+                    <img src="{{if $absoluteURL }}{{ absURL $logo }}{{ else }}{{ $logo }}{{ end }}" alt="{{ $title }} logo" height="30">
                 {{- else -}}
                     <span class="fw-bold">{{ $title }}</span>
                 {{- end -}}
@@ -238,7 +242,7 @@
                     {{- end -}}
     
                     <!-- Insert divider if applicable -->
-                    {{- if or $enableLanguage $enableVersions -}}
+                    {{- if and $menus (or $enableLanguage $enableVersions) -}}
                         <li class="nav-item py-2 py-md-1 col-12 col-md-auto d-none d-{{ $size }}-block">
                             <div class="vr d-none d-md-flex h-100 mx-md-2"></div>
                         </li>
@@ -258,7 +262,7 @@
                             <ul class="dropdown-menu dropdown-menu-end ">
                                 {{- if $page.IsTranslated -}}
                                     {{- range $page.AllTranslations -}}
-                                        <li><a class="dropdown-item {{ if eq .Language.Lang $currentLang }}active{{ end }}" href="{{ .Permalink }}">{{ .Language.LanguageName  }}</a></li>
+                                        <li><a class="dropdown-item {{ if eq .Language.Lang $currentLang }}active{{ end }}" href="{{ .RelPermalink }}">{{ .Language.LanguageName  }}</a></li>
                                     {{- end -}}
                                 {{- else -}}
                                     {{- range site.Languages -}}

layouts/partials/assets/persona.html

@@ -49,7 +49,7 @@
 
 {{- with $page -}}
     {{- if not $title }}{{ $title = .Title }}{{ end -}}
-    {{- if not $href }}{{ $href = .Permalink  }}{{ end -}}
+    {{- if not $href }}{{ $href = .RelPermalink  }}{{ end -}}
     {{- if not $content }}{{ $content = .Content }}{{ end -}}
     {{- if not $thumbnail }}{{ $thumbnail = .Params.thumbnail }}{{ end -}}
 {{- end -}}

layouts/partials/assets/sharing.html

@@ -10,7 +10,7 @@
             {{ T "shareLink" }}
             {{- range $index, $item := $list -}}
                 {{- $url := $item.url -}}
-                {{- $url = replace $url "{url}" $page.Permalink -}}
+                {{- $url = replace $url "{url}" $page.RelPermalink -}}
                 {{- $url = replace $url "{title}" (urlquery $page.Title) -}}
                 {{- $url = $url | safeURL -}}
                 {{- $target := "" -}}

layouts/partials/footer/scripts.html

@@ -1,3 +1,4 @@
+{{- $absoluteURL := site.Params.main.canonifyAssetsURLs | default false -}}
 {{- $filename := .filename | default "js/main.bundle.js" -}}
 {{- $match := .match | default "{js/*.js,js/vendor/**.js}" -}}
 {{- $page := .page -}}
@@ -23,9 +24,11 @@
     {{- end }}
 {{- end -}}
 
-{{- if not hugo.IsProduction -}}
-    <script src="{{ $js.Permalink }}"></script>
-{{ else -}}
+{{- if gt (len $js.Content) 0 -}}
+    {{- if not hugo.IsProduction -}}
+        <script src="{{ if $absoluteURL }}{{ $js.Permalink }}{{ else }}{{ $js.RelPermalink }}{{ end }}"></script>
+    {{ else -}}
         {{ $js = $js | minify | fingerprint -}}
-    <script src="{{ $js.Permalink }}" integrity="{{ $js.Data.Integrity }}" crossorigin="anonymous"></script>
+        <script src="{{ if $absoluteURL }}{{ $js.Permalink }}{{ else }}{{ $js.RelPermalink }}{{ end }}" integrity="{{ $js.Data.Integrity }}" crossorigin="anonymous"></script>
+    {{ end -}}
 {{ end -}}

layouts/partials/head/favicon.html

@@ -1,10 +1,11 @@
 <!-- Source: https://davelage.com/posts/hugo-favicons/ -->
+{{- $absoluteURL := site.Params.main.canonifyAssetsURLs | default false -}}
 {{ if .Site.Params.favicon.logo -}}
     {{ $favicon := resources.Get .Site.Params.favicon.logo -}}
     {{ range $i := .Site.Params.favicon.sizes -}} 
         {{ $image := $favicon.Resize (printf "%dx%d CatmullRom" $i $i) -}}
-        <link rel="icon" type="image/png" sizes="{{$i}}x{{$i}}" href="{{ $image.Permalink }}">
+        <link rel="icon" type="image/png" sizes="{{$i}}x{{$i}}" href="{{ if $absoluteURL }}{{ $image.Permalink }}{{ else }}{{ $image.RelPermalink }}{{ end }}">
     {{ end -}} 
     {{ $image := $favicon.Resize "180x CatmullRom" -}}
-    <link rel="apple-touch-icon" sizes="180x180" href="{{ $image.Permalink }}">
+    <link rel="apple-touch-icon" sizes="180x180" href="{{ if $absoluteURL }}{{ $image.Permalink }}{{ else }}{{ $image.RelPermalink }}{{ end }}">
 {{ end -}}

layouts/partials/head/stylesheet.html

@@ -1,3 +1,4 @@
+{{- $absoluteURL := site.Params.main.canonifyAssetsURLs | default false -}}
 {{- $source := .source | default "scss/app.scss" -}}
 {{- $target := .target | default "css/main.css" -}}
 {{- $page := .page -}}
@@ -6,7 +7,7 @@
 {{- $modules := "" -}}
 {{ if $core }}
     {{- if reflect.IsSlice site.Params.modules.excludeSCSS -}}
-        {{- $modules = complement site.Params.modules.excludeSCSS site.Params.modules.core -}}
+        {{- $modules = complement site.Params.modules.excludeSCSS (or site.Params.modules.core slice) -}}
     {{ else }}
         {{- $modules = site.Params.modules.core -}}
     {{ end }}
@@ -43,8 +44,8 @@
 {{- end -}}
 
 {{- if not hugo.IsProduction -}}
-    <link rel="stylesheet" href="{{ $css.Permalink }}">
+    <link rel="stylesheet" href="{{ if $absoluteURL }}{{ $css.Permalink }}{{ else }}{{ $css.RelPermalink }}{{ end }}">
 {{- else -}}
     {{- $css = $css | fingerprint | resources.PostProcess -}}
-    <link rel="stylesheet" href="{{ $css.Permalink }}" integrity="{{ $css.Data.Integrity }}" crossorigin="anonymous">
+    <link rel="stylesheet" href="{{ if $absoluteURL }}{{ $css.Permalink }}{{ else }}{{ $css.RelPermalink }}{{ end }}" integrity="{{ $css.Data.Integrity }}" crossorigin="anonymous">
 {{- end -}}

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.16.1",
+  "version": "0.16.5",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@gethinode/hinode",
-      "version": "0.16.1",
+      "version": "0.16.5",
       "license": "MIT",
       "devDependencies": {
         "@fortawesome/fontawesome-free": "^6.4.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.16.1",
+  "version": "0.16.5",
   "description": "Hinode is a clean documentation and blog theme for Hugo, an open-source static site generator",
   "keywords": [
     "hugo",
@@ -20,7 +20,7 @@
     "prestart": "npm run clean && npm run mod:vendor",
     "start": "hugo server --bind=0.0.0.0 --disableFastRender",
     "start:prod": "hugo server --bind=0.0.0.0 --disableFastRender --printI18nWarnings -e production",
-    "prebuild": "npm run clean",
+    "prebuild": "npm run clean && npm run -s mod:install",
     "build": "hugo --gc --minify",
     "build:debug": "hugo -e debug --debug",
     "build:preview": "npm run build -D -F",
@@ -32,6 +32,7 @@
     "lint:markdown": "markdownlint-cli2 \"*.md\" \"content/**/*.md\"",
     "lint:markdown-fix": "markdownlint-cli2-fix \"*.md\" \"content/**/*.md\"",
     "mod:clean": "hugo mod clean",
+    "mod:install": "hugo mod get ./... && npm run -s mod:vendor && npm run -s mod:tidy",
     "mod:update": "hugo mod get -u ./... && npm run -s mod:vendor && npm run -s mod:tidy",
     "mod:tidy": "hugo mod tidy",
     "mod:vendor": "rimraf _vendor && hugo mod vendor",
@@ -43,7 +44,7 @@
     "create:syntax-light": "hugo gen chromastyles --style=github > ./assets/scss/components/_syntax-light.scss",
     "create:syntax-dark": "hugo gen chromastyles --style=github-dark > ./assets/scss/components/_syntax-dark.scss",
     "update:syntax-dark": "replace-in-files --string=\"#ffffcc\" --replacement=\"#b8b800\" ./assets/scss/components/_syntax-dark.scss",
-    "upgrade": "npx npm-check-updates -u"
+    "upgrade": "npx npm-check-updates -u && mod:update"
   },
   "repository": {
     "type": "git",