Merge pull request #951 from gethinode/image

Fix linting issue

assets/scss/components/_card.scss

@@ -68,8 +68,7 @@
     }
 }
 
-.card-zoom card-body-link,
-.card-body-link {
+.card-zoom .card-body-link {
     &:hover,
     &:focus {
         color: shade-color($primary, $link-shade-percentage) if($enable-important-utilities, !important, null);
@@ -78,8 +77,7 @@
 
 @if $enable-dark-mode {
     @include color-mode(dark) {
-        .card-zoom card-body-link,
-        .card-body-link {
+        .card-zoom .card-body-link {
             &:hover,
             &:focus {
                 color: $primary-bg-subtle-dark if($enable-important-utilities, !important, null);

config/_default/params.toml

@@ -36,6 +36,16 @@
         raw = false        
 # toml-docs-end modules
 
+# toml-docs-start images
+[images]
+    [images.cloudinary]
+        host = "cloudinary"
+    [images.imagekit]
+        host = "imagekit"
+    [images.imgix]
+        host = "imgix"
+# toml-docs-end images
+
 # toml-docs-start debugging
 [debugging]
     showJS = false

config/_default/server.toml

@@ -15,7 +15,7 @@ for = '/**'
             https://*.google-analytics.com https://*.analytics.google.com https://*.googletagmanager.com; \
         font-src 'self' https://fonts.gstatic.com; \
         frame-src 'self' https://www.youtube-nocookie.com https://www.youtube.com; \
-        img-src 'self' data: https://*.cloudinary.com https://i.vimeocdn.com https://i.ytimg.com https://*.google-analytics.com https://*.googletagmanager.com https://tile.openstreetmap.org; \
+        img-src 'self' data: https://*.imgix.net https://*.imagekit.io https://*.cloudinary.com https://i.vimeocdn.com https://i.ytimg.com https://*.google-analytics.com https://*.googletagmanager.com https://tile.openstreetmap.org; \
         manifest-src 'self'; \
         media-src 'self' \
         """

data/dimensions.yml

@@ -13,7 +13,7 @@
     - 992x661
     - 1200x800
     - 1400x933
-    - 2800x1866
+    - 2800x1867
 - ratio: 1x1
   dimensions:
     - 576x576
@@ -29,7 +29,7 @@
     - 992x558
     - 1200x675
     - 1400x788
-    - 2800x1576
+    - 2800x1575
 - ratio: 21x9
   dimensions:
     - 576x247

exampleSite/config/_default/params.toml

@@ -70,6 +70,14 @@
 [messages]
     placement = "bottom-right"
 
+[dam]
+    dimensions = "dimensions.yml"
+
+[[dam.providers]]
+    name = "Cloudinary"
+    pattern = "cloudinary"
+    adapter = "assets/adapters/cloudinary.html"
+
 [sharing]
     enabled = true
     sort = "weight"

exampleSite/config/_default/server.toml

@@ -15,7 +15,7 @@ for = '/**'
             https://*.google-analytics.com https://*.analytics.google.com https://*.googletagmanager.com; \
         font-src 'self' https://fonts.gstatic.com; \
         frame-src 'self' https://www.youtube-nocookie.com https://www.youtube.com; \
-        img-src 'self' data: https://*.cloudinary.com https://i.vimeocdn.com https://i.ytimg.com https://*.google-analytics.com https://*.googletagmanager.com https://tile.openstreetmap.org; \
+        img-src 'self' data: https://*.imgix.net https://*.imagekit.io https://*.cloudinary.com https://i.vimeocdn.com https://i.ytimg.com https://*.google-analytics.com https://*.googletagmanager.com https://tile.openstreetmap.org; \
         manifest-src 'self'; \
         media-src 'self' \
         """

exampleSite/content/en/blog/image.md

@@ -5,11 +5,7 @@ date: 2024-05-19
 description: Include responsive images from local sources and selected CDN image providers.
 tags: ["blog"]
 thumbnail:
-  url: https://res.cloudinary.com/demo/image/upload/v1689803100/ai/hiker.jpg
-  author: Nathan Dumlao
-  authorURL: https://unsplash.com/@nate_dumlao
-  origin: Unsplash
-  originURL: https://unsplash.com/photos/QLPWQvHvmII
+  url: https://assets.imgix.net/examples/bluehat.jpg
 ---
 
 ## Cloudinary
@@ -22,3 +18,25 @@ As an example, the following shortcode displays an image with rounded corners an
     ratio="21x9" caption="Cloudinary image" class="rounded" */>}}
 {{< /example >}}
 <!-- markdownlint-enable MD037 -->
+
+## ImageKit.io
+
+As an example, the following shortcode displays an image with rounded corners and a 21x9 aspect ratio.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* image src="https://ik.imagekit.io/demo/default-image.jpg"
+    ratio="21x9" caption="ImageKit.io image" class="rounded" */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Imgix
+
+As an example, the following shortcode displays an image with rounded corners and a 21x9 aspect ratio.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* image src="https://assets.imgix.net/examples/bluehat.jpg"
+    ratio="21x9" caption="imgix image" class="rounded" */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->

exampleSite/hugo_stats.json

@@ -511,6 +511,8 @@
       "groupe-de-cartes",
       "icon",
       "image",
+      "imagekitio",
+      "imgix",
       "indicateur-de-chargement",
       "infobulle",
       "invite-de-commandes",

go.mod

@@ -9,8 +9,8 @@ require (
 	github.com/gethinode/mod-fontawesome v1.8.2 // indirect
 	github.com/gethinode/mod-katex v1.0.9 // indirect
 	github.com/gethinode/mod-leaflet v1.0.1 // indirect
-	github.com/gethinode/mod-lottie v1.4.6 // indirect
-	github.com/gethinode/mod-utils/v2 v2.2.2 // indirect
+	github.com/gethinode/mod-lottie v1.4.7 // indirect
+	github.com/gethinode/mod-utils/v2 v2.3.0 // indirect
 	github.com/nextapps-de/flexsearch v0.0.0-20240110101704-4c3966709f85 // indirect
 	github.com/twbs/bootstrap v5.3.3+incompatible // indirect
 )

go.sum

@@ -160,6 +160,8 @@ github.com/gethinode/mod-lottie v1.4.4 h1:Lv7J+lAMx++aK9h0L7vAgsjyOZgrjux4xPz4Tp
 github.com/gethinode/mod-lottie v1.4.4/go.mod h1:7tsZjlFgMlj2iWBIS9uOtHHsCrfx9W7S8OsBrZeSVGU=
 github.com/gethinode/mod-lottie v1.4.6 h1:L6zvfbq+FQUWTG3X/wWFCvb91WOxJuIkJUlZOd+QJ1Q=
 github.com/gethinode/mod-lottie v1.4.6/go.mod h1:1/+7U/Q5IuaqkzTrvXK1CnPE7ANnTRsG5k+KaXQUQwE=
+github.com/gethinode/mod-lottie v1.4.7 h1:5Hes0xY/l8ygzJ8YQIzdqCmvGrDQs8D8qZ/vR1fQh/Q=
+github.com/gethinode/mod-lottie v1.4.7/go.mod h1:FvcG3NjXOBOnwou0QvXYNPHpybxwT6yxmSh4N+nBD9s=
 github.com/gethinode/mod-utils v1.0.0 h1:cqHm2xS5uDiJzRm1KfHaNbq6uMVDKLhQa8/BuTZ1nhY=
 github.com/gethinode/mod-utils v1.0.0/go.mod h1:ONJm3pHCq7nvaPNjusLZNCeCbhOhSBH4HVKHwK1FdYE=
 github.com/gethinode/mod-utils v1.0.1 h1:jhZGlGFHHL1f5HXbBMXfiZ2gCz4TVafAzjnRPTIBSEE=
@@ -184,6 +186,8 @@ github.com/gethinode/mod-utils/v2 v2.1.1 h1:aLBcS9Zbx+dqnu5oBsTM01AkkN5nwwifgbV4
 github.com/gethinode/mod-utils/v2 v2.1.1/go.mod h1:GTYeknoLujNjfDxI+V9Dcug26CYJSTJ0B/U2dagw9oY=
 github.com/gethinode/mod-utils/v2 v2.2.2 h1:ZRxWIJKmZIDYsoMS3WhxxC+BWJrkd1dcZ8rz/cLZExc=
 github.com/gethinode/mod-utils/v2 v2.2.2/go.mod h1:GTYeknoLujNjfDxI+V9Dcug26CYJSTJ0B/U2dagw9oY=
+github.com/gethinode/mod-utils/v2 v2.3.0 h1:e3uhlAGasvXe+cgvcmzRe05Zo4UEx86uk0TbnxtyB6U=
+github.com/gethinode/mod-utils/v2 v2.3.0/go.mod h1:GTYeknoLujNjfDxI+V9Dcug26CYJSTJ0B/U2dagw9oY=
 github.com/nextapps-de/flexsearch v0.0.0-20230711092928-1243fd883ec3 h1:H/qVR5O4BXjRjD+5PZB+r4ug2BSJ2Of4RtwOntd+OKo=
 github.com/nextapps-de/flexsearch v0.0.0-20230711092928-1243fd883ec3/go.mod h1:5GdMfPAXzbA2gXBqTjC6l27kioSYzHlqDMh0+wyx7sU=
 github.com/nextapps-de/flexsearch v0.0.0-20240108021025-afd75f742f22 h1:re7L8FxbXQpnX8BgzkdUnDpsUmloGNyLmiy2ZCln8pg=

layouts/partials/assets/adapters/cloudinary.html

@@ -33,7 +33,7 @@
     {{ $operation := "" }}
     {{ if $format }}
         {{ $operation = printf "%s,h_%d,w_%d" $transform $height $width }}
-        {{ $file = printf "%s.%s" (path.BaseName $file) $format }}
+        {{ $file = printf "%s.%s" (strings.TrimSuffix (path.Ext $file) $file) $format }}
     {{ else }}
         {{ $operation = printf "f_auto,%s,h_%d,w_%d" $transform $height $width }}
     {{ end }}

layouts/partials/assets/adapters/imagekit.html

@@ -0,0 +1,48 @@
+<!-- 
+    Copyright © 2024 The Hinode Team / Mark Dumay. All rights reserved.
+    Use of this source code is governed by The MIT License (MIT) that can be found in the LICENSE file.
+    Visit gethinode.com/license for more details.
+-->
+
+{{ $error := false }}
+
+<!-- Validate arguments -->
+{{ if partial "utilities/IsInvalidArgs.html" (dict "structure" "image-adapter" "args" . "group" "partial") }}
+    {{ errorf "partial [assets/adapter/imagekit.html] - Invalid arguments" -}}
+    {{ $error = true }}
+{{ end }}
+
+<!-- Initialize arguments -->
+{{ $host := .host }}
+{{ $dir := .dir }}
+{{ $file := .file }}
+{{ $format := .format }}
+{{ $transform := .transform }}
+{{ $height := .height }}
+{{ $width := .width }}
+{{ if eq $transform "fill" }}{{ $transform = "c-maintain_ratio" }}{{ else }}{{ $transform = "c-at_max" }}{{ end }}
+{{ $element := "" }}
+
+<!-- Validate image format is supported -->
+{{ if and $format (not (in (slice "jpg" "jpeg" "webp" "avif" "png") $format)) }}
+    {{ warnf "Image format not supported by ImageKit.io: %s.%s" (path.BaseName $file) $format }}
+    {{ $format = "jpg" }}
+{{ end }}
+
+<!-- Split path between end point and image path -->
+{{ $newdir := printf "/%s" (index (split $dir "/") 1) }}
+{{ $file = urls.JoinPath (strings.TrimPrefix $newdir $dir) $file }}
+{{ $dir = $newdir }}
+
+<!-- Generate image URL -->
+{{ if not $error }}
+    {{ $operation := "" }}
+    {{ if $format }}
+        {{ $operation = printf "tr:f-%s,%s,h-%d,w-%d" $format $transform $height $width }}
+    {{ else }}
+        {{ $operation = printf "tr:f-auto,%s,h-%d,w-%d" $transform $height $width }}
+    {{ end }}
+    {{- $element = urls.JoinPath (slice "https://" $host $dir $operation $file) -}}
+{{ end }}
+
+{{ return $element }}

layouts/partials/assets/adapters/imgix.html

@@ -0,0 +1,43 @@
+<!-- 
+    Copyright © 2024 The Hinode Team / Mark Dumay. All rights reserved.
+    Use of this source code is governed by The MIT License (MIT) that can be found in the LICENSE file.
+    Visit gethinode.com/license for more details.
+-->
+
+{{ $error := false }}
+
+<!-- Validate arguments -->
+{{ if partial "utilities/IsInvalidArgs.html" (dict "structure" "image-adapter" "args" . "group" "partial") }}
+    {{ errorf "partial [assets/adapter/imgix.html] - Invalid arguments" -}}
+    {{ $error = true }}
+{{ end }}
+
+<!-- Initialize arguments -->
+{{ $host := .host }}
+{{ $dir := .dir }}
+{{ $file := .file }}
+{{ $format := .format }}
+{{ $transform := .transform }}
+{{ $height := .height }}
+{{ $width := .width }}
+{{ if eq $transform "fill" }}{{ $transform = "crop" }}{{ else }}{{ $transform = "max" }}{{ end }}
+{{ $element := "" }}
+
+<!-- Validate image format is supported -->
+{{ if and $format (not (in (slice "avif" "gif" "jp2" "jpg" "json" "jxr" "pjpg" "mp4" "png" "png8" "png32" "webm" "webp" "blurhash") $format)) }}
+    {{ warnf "Image format not supported by imgix: %s.%s" (path.BaseName $file) $format }}
+    {{ $format = "jpg" }}
+{{ end }}
+
+<!-- Generate image URL -->
+{{ if not $error }}
+    {{ $operation := "" }}
+    {{ if $format }}
+        {{ $operation = printf "fm=%s&fit=%s&h=%d&w=%d" $format $transform $height $width }}
+    {{ else }}
+        {{ $operation = printf "f_auto&fit=%s&h=%d&w=%d" $transform $height $width }}
+    {{ end }}
+    {{- $element = printf "%s?%s" (urls.JoinPath (slice "https://" $host $dir $file)) $operation -}}
+{{ end }}
+
+{{ return $element }}

layouts/partials/assets/helpers/GetDimension.html

@@ -3,11 +3,23 @@
 -->
 
 {{ $ratio := .ratio }}
-
 {{ $dim := "" }}
-{{ $matches := first 1 (where site.Data.dimensions "ratio" $ratio) }}
-{{ if eq ($matches | len) 1 }}
-    {{ $dim = (index $matches 0).dimensions }}
+{{ $default := dict "4x3" "1400x1050" "3x2" "1400x933" "1x1" "1400x1400" "16x9" "1400x788" "21x9" "1400x600" "auto" "1400" }}
+
+<!-- Initialize dimensions data - stripping unsupported file extension -->
+{{ $config := "dimensions" }}
+{{ with index site.Params "dam" }}{{ with index . "dimensions" }}{{ $config = . }}{{ end }}{{ end }}
+{{ $config = path.Join (path.Dir $config) (path.BaseName $config) }}
+
+{{ with index site.Data $config }}
+    {{ $matches := first 1 (where . "ratio" $ratio) }}
+    {{ if eq ($matches | len) 1 }}
+        {{ $dim = (index $matches 0).dimensions }}
+    {{ end }}
+{{ end }}
+
+{{ if not $dim }}
+    {{ $dim = slice (index $default $ratio)  }}
 {{ end }}
 
 {{ return $dim }}

layouts/partials/assets/helpers/image-definition.html

@@ -30,11 +30,18 @@
     {{- $anchor = index $segments 1 -}}
 {{- end -}}
 
-<!-- TODO: improve CDN detection / handling -->
-{{ $hook := "hugo" }}
-{{ if findRE "cloudinary" (urls.Parse $url).Hostname }}
-    {{ $hook = "cloudinary" }}
-{{- end -}}
+<!-- Identify image provider -->
+{{ $hook := "" }}
+{{ range $provider, $val := site.Params.images }}
+    {{ if not $hook }}    
+        {{ with index $val "host" }}
+            {{ if (findRE . (urls.Parse $url).Hostname) }}
+                {{ $hook = $provider }}
+            {{ end }}
+        {{ end }}
+    {{ end }}
+{{ end }}
+{{ if not $hook }}{{ $hook = "hugo" }}{{ end }}
 
 <!-- Define image dimensions -->
 {{ $dims := slice }}
@@ -72,9 +79,11 @@
 <!-- Derive image width and height -->
 {{ $width := "" }}
 {{ $height := "" }}
-{{ range $dim := ($dims | last 1) }}
-    {{ $width = (int (index (split $dim "x") 0)) }}
-    {{ $height = (int (index (split $dim "x") 1)) }}
+{{ with $dims }}
+    {{ range $dim := (. | last 1) }}
+        {{ $width = (int (index (split $dim "x") 0)) }}
+        {{ $height = (int (index (split $dim "x") 1)) }}
+    {{ end }}
 {{ end }}
 
 <!-- Generate image urls -->

layouts/partials/assets/helpers/image-set.html

@@ -13,12 +13,19 @@
 {{ $file := index ((split $dir "/") | collections.Reverse) 0 }}
 {{ $dir = strings.TrimSuffix $file $dir }}
 
+{{ $adapter := (printf "assets/adapters/%s.html" $hook) }}
+{{ if not (fileExists (path.Join "/layouts/partials" $adapter)) }}
+    {{ warnf "Cannot find adapter: %s" (path.Join "/layouts/partials" $adapter) }}
+    {{ $hook = "hugo" }}
+    {{ $adapter = "assets/adapters/hugo.html" }}
+{{ end }}
+
 {{ $imgset := slice }}
 {{- range $index, $dim := $dims -}}
     {{ $width := (int (index (split $dim "x") 0)) }}
     {{ $height := (int (index (split $dim "x") 1)) }}
 
-    {{- $element := partial (printf "assets/adapters/%s.html" $hook) (dict 
+    {{- $element := partial $adapter (dict 
         "host" $host
         "dir" $dir
         "file" $file

netlify.toml

@@ -33,7 +33,7 @@
             font-src 'self' https://*.netlify.app https://fonts.gstatic.com; \
             frame-src 'self' https://www.youtube-nocookie.com https://www.youtube.com \
                 app.netlify.com; \
-            img-src 'self' data: https://*.cloudinary.com https://*.netlify.app https://i.vimeocdn.com https://i.ytimg.com https://*.google-analytics.com https://*.googletagmanager.com https://tile.openstreetmap.org; \
+            img-src 'self' data: https://*.imgix.net https://*.imagekit.io https://*.cloudinary.com https://*.netlify.app https://i.vimeocdn.com https://i.ytimg.com https://*.google-analytics.com https://*.googletagmanager.com https://tile.openstreetmap.org; \
             manifest-src 'self'; \
             media-src 'self' \
             """

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.24.0-alpha2",
+  "version": "0.24.0-beta1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@gethinode/hinode",
-      "version": "0.24.0-alpha2",
+      "version": "0.24.0-beta1",
       "license": "MIT",
       "devDependencies": {
         "@fullhuman/postcss-purgecss": "^6.0.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.24.0-alpha2",
+  "version": "0.24.0-beta1",
   "description": "Hinode is a clean documentation and blog theme for Hugo, an open-source static site generator",
   "keywords": [
     "hugo",