Merge pull request #359 from gethinode/develop

Refinement

.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,

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 -}}
+        {{- partial "footer/scripts.html" (dict "filename" "js/critical.bundle.js" "match" "js/critical/**.js" "header" true "page" .) -}}
         <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/partials/assets/navbar.html

@@ -105,11 +105,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) -}}
-    {{- errorf "partial [assets/navbar.html] - Invalid value for param 'menus': %s" $menuName -}}
+    {{- if ne $menuName $defaultMenu }}
+        {{- errorf "partial [assets/navbar.html] - Invalid value for param 'menus': %s" $menuName -}}
+    {{- end -}}
 {{- end -}}
 
 {{- $size := "md" -}}
@@ -147,7 +150,7 @@
     {{- end -}}
 {{- end -}}
 
-{{- $enableDarkMode := default true site.Params.main.enableDarkMode -}}
+{{- $enableDarkMode := default false site.Params.main.enableDarkMode -}}
 {{- with .mode -}}
     {{- $darkModeParam := . -}}
     {{- if in $supportedFlags $darkModeParam -}}
@@ -238,7 +241,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>

layouts/partials/footer/scripts.html

@@ -23,9 +23,11 @@
     {{- end }}
 {{- end -}}
 
-{{- if not hugo.IsProduction -}}
-    <script src="{{ $js.Permalink }}"></script>
-{{ else -}}
-    {{ $js = $js | minify | fingerprint -}}
-    <script src="{{ $js.Permalink }}" integrity="{{ $js.Data.Integrity }}" crossorigin="anonymous"></script>
+{{- if gt (len $js.Content) 0 -}}
+    {{- if not hugo.IsProduction -}}
+        <script src="{{ $js.Permalink }}"></script>
+    {{ else -}}
+        {{ $js = $js | minify | fingerprint -}}
+        <script src="{{ $js.Permalink }}" integrity="{{ $js.Data.Integrity }}" crossorigin="anonymous"></script>
+    {{ end -}}
 {{ end -}}

layouts/partials/head/stylesheet.html

@@ -6,7 +6,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 }}

layouts/shortcodes/docs.html

@@ -44,6 +44,14 @@
     {{ errorf "Invalid value for param 'show': %s" $showParam -}}
 {{ end -}}
 
+{{ $fullParam := "true" -}}
+{{ $full := true -}}
+{{ with .Get "full" }}{{ $fullParam = . }}{{ end -}}
+{{ if in $supportedFlags $fullParam -}}
+    {{ if eq $fullParam "true" }}{{ $full = true }}{{ else }}{{ $full = false }}{{ end -}}
+{{ else -}}
+    {{ errorf "Invalid value for param 'full': %s" $fullParam -}}
+{{ end -}}
 
 {{- /* If any parameters are missing, print an error and exit */ -}}
 {{- if or (not $name) (not $file) -}}
@@ -72,7 +80,7 @@
                 data-bs-target=".multi-{{ $id }}" 
                 aria-expanded="false" 
                 aria-controls="body-{{ $id }} footer-{{ $id }}">
-                <small>{{ strings.TrimPrefix $basePath $file }}</small>
+                <small>{{ if $full }}{{ strings.TrimPrefix $basePath $file }}{{ else }}{{ path.Base $file }}{{ end }}</small>
             </a>
         </li>
     </ul>

layouts/shortcodes/file.html

@@ -1,7 +1,7 @@
 {{- /*
     Source: https://github.com/twbs/bootstrap/blob/main/site/layouts/shortcodes/scss-docs.html
 
-    Usage: `file path="path/to/filename" lang="lang" show="true"`
+    Usage: `file path="path/to/filename" lang="lang" show="true" full="true"`
 
     Prints the full content of any given file supported by the Chroma syntax highlighter.
 */ -}}
@@ -28,6 +28,15 @@
     {{ errorf "Invalid value for param 'show': %s" $showParam -}}
 {{ end -}}
 
+{{ $fullParam := "true" -}}
+{{ $full := true -}}
+{{ with .Get "full" }}{{ $fullParam = . }}{{ end -}}
+{{ if in $supportedFlags $fullParam -}}
+    {{ if eq $fullParam "true" }}{{ $full = true }}{{ else }}{{ $full = false }}{{ end -}}
+{{ else -}}
+    {{ errorf "Invalid value for param 'full': %s" $fullParam -}}
+{{ end -}}
+
 {{- /* If any parameters are missing, print an error and exit */ -}}
 {{- if not $file -}}
     {{- errorf "%s: %q: Missing required parameters! Got: path=%q!" .Position .Name $file -}}
@@ -46,7 +55,7 @@
                 data-bs-target=".multi-{{ $id }}" 
                 aria-expanded="false" 
                 aria-controls="body-{{ $id }} footer-{{ $id }}">
-                <small>{{ strings.TrimPrefix $basePath $file }}</small>
+                <small>{{ if $full }}{{ strings.TrimPrefix $basePath $file }}{{ else }}{{ path.Base $file }}{{ end }}</small>
             </a>
         </li>
     </ul>

package-lock.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.16.0",
+  "version": "0.16.4",
   "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",