feat(article-link): add support for hotlinkFeatureImages

2026-01-30 16:31:52 +01:00 · 2025-09-18 04:13:06 +08:00
parent 7cb8dcc4a1
commit 4b9e63fd99
12 changed files with 199 additions and 76 deletions
--- a/config/_default/params.toml
+++ b/config/_default/params.toml
@@ -26,6 +26,7 @@ disableTextInHeader = false
 # defaultBackgroundImage = "IMAGE.jpg" # used as default for background images 
 # defaultFeaturedImage = "IMAGE.jpg" # used as default for featured images in all articles
 # defaultSocialImage = "/android-chrome-512x512.png" # used as default for social media sharing (Open Graph and Twitter)
+hotlinkFeatureImages = false

 # highlightCurrentMenuArea = true
 # smartTOC = true
--- a/exampleSite/config/_default/params.toml
+++ b/exampleSite/config/_default/params.toml
@@ -26,6 +26,7 @@ disableTextInHeader = false
 defaultBackgroundImage = "/img/background.svg"
 defaultFeaturedImage = "/img/featured.svg"
 defaultSocialImage = "/img/blowfish_banner.png"
+hotlinkFeatureImages = false

 highlightCurrentMenuArea = true
 smartTOC = true
--- a/exampleSite/content/docs/configuration/index.it.md
+++ b/exampleSite/content/docs/configuration/index.it.md
@@ -185,6 +185,7 @@ Many of the article defaults here can be overridden on a per article basis by sp
 | `defaultBackgroundImage` | _Not set_ | Default background image for both `background` homepage layout and `background` hero style |
 | `defaultFeaturedImage` | _Not set_ | Default background image for all `featured` images across articles, will be overridden by a local `featured` image. |
 | `defaultSocialImage` | _Not set_ | Default image for social media sharing (Open Graph and Twitter). Will be overridden by a local `feature` image if available. |
+| `hotlinkFeatureImages` | `false` | Hotlink external images in article feature images and article cards. Those images will not be processed by Hugo. |
 | `highlightCurrentMenuArea` | _Not set_ | Marks menu entries in the main menu when selected |
 | `smartTOC` | _Not set_ | Activate smart Table of Contents, items in view will be highlighted. |
 | `smartTOCHideUnfocusedChildren` | _Not set_ | When smart Table of Contents is turned on, this will hide deeper levels of the table when they are not in focus. |
--- a/exampleSite/content/docs/configuration/index.ja.md
+++ b/exampleSite/content/docs/configuration/index.ja.md
@@ -185,6 +185,7 @@ Blowfish は、テーマの機能を制御する多数の設定パラメータ
 | `defaultBackgroundImage` | _未設定_ | `background` ホームページレイアウトと `background` ヒーロースタイルの両方のデフォルトの背景画像です。 |
 | `defaultFeaturedImage` | _未設定_ | 記事全体のすべての `featured` 画像のデフォルトの背景画像です。ローカルの `featured` 画像によってオーバーライドされます。 |
 | `defaultSocialImage` | _未設定_ | ソーシャルメディア共有（Open Graph と Twitter）用のデフォルト画像。ローカルの `featured` 画像によってオーバーライドされます。 |
+| `hotlinkFeatureImages` | `false` | 記事のアイキャッチ画像や記事カードで外部画像をホットリンクします。これらの画像は Hugo によって処理されません。 |
 | `highlightCurrentMenuArea` | _未設定_ | メインメニューのメニュー項目が選択されているときにマークを付けます。 |
 | `smartTOC` | _未設定_ | スマート目次をアクティブにします。表示されている項目が強調表示されます。 |
 | `smartTOCHideUnfocusedChildren` | _未設定_ | スマート目次がオンになっている場合、フォーカスされていないときに、テーブルのより深いレベルが非表示になります。 |
--- a/exampleSite/content/docs/configuration/index.md
+++ b/exampleSite/content/docs/configuration/index.md
@@ -191,6 +191,7 @@ Many of the article defaults here can be overridden on a per article basis by sp
 | `defaultBackgroundImage` | _Not set_ | Default background image for both `background` homepage layout and `background` hero style |
 | `defaultFeaturedImage` | _Not set_ | Default background image for all `featured` images across articles, will be overridden by a local `featured` image. |
 | `defaultSocialImage` | _Not set_ | Default image for social media sharing (Open Graph and Twitter). Will be overridden by a local `feature` image. |
+| `hotlinkFeatureImages` | `false` | Hotlink external images in article feature images and article cards. Those images will not be processed by Hugo. |
 | `highlightCurrentMenuArea` | _Not set_ | Marks menu entries in the main menu when selected |
 | `smartTOC` | _Not set_ | Activate smart Table of Contents, items in view will be highlighted. |
 | `smartTOCHideUnfocusedChildren` | _Not set_ | When smart Table of Contents is turned on, this will hide deeper levels of the table when they are not in focus. |
--- a/exampleSite/content/docs/configuration/index.zh-cn.md
+++ b/exampleSite/content/docs/configuration/index.zh-cn.md
@@ -189,6 +189,7 @@ Blowfish 提供了大量控制主题功能的配置参数，下面的表格中
 | `defaultBackgroundImage` | 无 | 设置默认背景图，用于 `background` 和 `hero` 布局下的主页。 |
 | `defaultFeaturedImage` | 无 | 设置默认背景图片，用于所有文章的`featured`图片，可以通过文章目录中的 `featured` 图片替换。 |
 | `defaultSocialImage` | 无 | 社交媒体分享（Open Graph 和 Twitter）使用的默认图片，可以通过文章目录中的 `featured` 图片替换。 |
+| `hotlinkFeatureImages` | `false` | 在文章特色图片和文章卡片中外链图片。这些图片不会被 Hugo 处理。 |
 | `highlightCurrentMenuArea` | 无 | 当菜单被选择时，标记主菜单中的菜单项。 |
 | `smartTOC` | 无 | 开启智能目录，视图中的项目将会被高亮显示。 |
 | `smartTOCHideUnfocusedChildren` | 无 | 当开启智能目录，如果目录级别不再被聚焦时，将会隐藏更深层次的目录。 |
--- a/layouts/_default/baseof.html
+++ b/layouts/_default/baseof.html
@@ -6,6 +6,7 @@
  data-default-appearance="{{ site.Params.defaultAppearance | default `light` }}"
  data-auto-appearance="{{ site.Params.autoSwitchAppearance | default `true` }}">
  {{- partial "head.html" . -}}
+  {{- partialCached "init.html" . -}}


  <body
--- a/layouts/partials/article-link/_shortcode.html
+++ b/layouts/partials/article-link/_shortcode.html
@@ -1,11 +1,17 @@
 {{/* Used by
  1. article shortcode
+
+  The four variants of article-link are very similar. Despite appearances, as of df859f:
+  - _shortcode.html uses $page := $target, while the others use $page := .Page
+  - card-related.html does not have the hideFeatureImage option, while the others do
+
+  $page is added intentionally to prevent small differences inside
 */}}
 {{ $target := .target }}
 {{ $shortcodeShowSummary := .showSummary }}
 {{ $shortcodeCompactSummary := .compactSummary }}
 {{ $constrainItemsWidth := site.Params.list.constrainItemsWidth | default false }}
-{{ $disableImageOptimization := site.Params.disableImageOptimization | default false }}
+{{ $disableImageOptimization := site.Store.Get "disableImageOptimization" }}

 {{ $cardClasses := "flex flex-col md:flex-row relative" }}
 {{ $figureClasses := "" }}
@@ -25,27 +31,44 @@
  {{ $cardClasses = printf "%s max-w-prose" $cardClasses }}
 {{ end }}

+{{ $page := $target }}
 {{ $featured := "" }}
 {{ $featuredURL := "" }}
 {{ if not $target.Params.hideFeatureImage }}
-  {{ with $target.Params.featureimage }}
+  {{/* frontmatter */}}
+  {{ with $page }}
+    {{ with .Params.featureimage }}
      {{ if or (strings.HasPrefix . "http:") (strings.HasPrefix . "https:") }}
+        {{ if site.Params.hotlinkFeatureImages }}
+          {{ $featuredURL = . }}
+        {{ else }}
          {{ $featured = resources.GetRemote . }}
+        {{ end }}
      {{ else }}
        {{ $featured = resources.Get . }}
      {{ end }}
    {{ end }}

-  {{ if not $featured }}
-    {{ $images := $target.Resources.ByType "image" }}
+    {{/* page resources */}}
+    {{ if not (or $featured $featuredURL) }}
+      {{ $images := .Resources.ByType "image" }}
      {{ range slice "*feature*" "*cover*" "*thumbnail*" }}
        {{ if not $featured }}{{ $featured = $images.GetMatch . }}{{ end }}
      {{ end }}
-    {{ if not $featured }}
-      {{ with site.Params.defaultFeaturedImage }}{{ $featured = resources.Get . }}{{ end }}
+    {{ end }}
+
+    {{/* fallback to default */}}
+    {{ if not (or $featured $featuredURL) }}
+      {{ $default := site.Store.Get "defaultFeaturedImage" }}
+      {{ if $default.url }}
+        {{ $featuredURL = $default.url }}
+      {{ else if $default.obj }}
+        {{ $featured = $default.obj }}
      {{ end }}
    {{ end }}

+    {{/* generate image URL if not hotlink */}}
+    {{ if not $featuredURL }}
      {{ with $featured }}
        {{ $featuredURL = .RelPermalink }}
        {{ if not (or $disableImageOptimization (eq .MediaType.SubType "svg")) }}
@@ -53,6 +76,8 @@
        {{ end }}
      {{ end }}
    {{ end }}
+  {{ end }}
+{{ end }}


 <article class="{{ $cardClasses }}">
--- a/layouts/partials/article-link/card-related.html
+++ b/layouts/partials/article-link/card-related.html
@@ -1,34 +1,53 @@
 {{/* Used by
  1. layouts/partials/related.html (related articles in single page)
 */}}
-{{ $disableImageOptimization := .Page.Site.Params.disableImageOptimization | default false }}
+{{ $disableImageOptimization := site.Store.Get "disableImageOptimization" }}

+{{ $page := .Page }}
 {{ $featured := "" }}
 {{ $featuredURL := "" }}
+{{/* frontmatter */}}
+{{ with $page }}
  {{ with .Params.featureimage }}
    {{ if or (strings.HasPrefix . "http:") (strings.HasPrefix . "https:") }}
+      {{ if site.Params.hotlinkFeatureImages }}
+        {{ $featuredURL = . }}
+      {{ else }}
        {{ $featured = resources.GetRemote . }}
+      {{ end }}
    {{ else }}
      {{ $featured = resources.Get . }}
    {{ end }}
  {{ end }}

-{{ if not $featured }}
-  {{ $images := $.Resources.ByType "image" }}
+  {{/* page resources */}}
+  {{ if not (or $featured $featuredURL) }}
+    {{ $images := .Resources.ByType "image" }}
    {{ range slice "*feature*" "*cover*" "*thumbnail*" }}
      {{ if not $featured }}{{ $featured = $images.GetMatch . }}{{ end }}
    {{ end }}
-  {{ if not $featured }}
-    {{ with site.Params.defaultFeaturedImage }}{{ $featured = resources.Get . }}{{ end }}
+  {{ end }}
+
+  {{/* fallback to default */}}
+  {{ if not (or $featured $featuredURL) }}
+    {{ $default := site.Store.Get "defaultFeaturedImage" }}
+    {{ if $default.url }}
+      {{ $featuredURL = $default.url }}
+    {{ else if $default.obj }}
+      {{ $featured = $default.obj }}
    {{ end }}
  {{ end }}

+  {{/* generate image URL if not hotlink */}}
+  {{ if not $featuredURL }}
    {{ with $featured }}
      {{ $featuredURL = .RelPermalink }}
      {{ if not (or $disableImageOptimization (eq .MediaType.SubType "svg")) }}
        {{ $featuredURL = (.Resize "600x").RelPermalink }}
      {{ end }}
    {{ end }}
+  {{ end }}
+{{ end }}


 <article
--- a/layouts/partials/article-link/card.html
+++ b/layouts/partials/article-link/card.html
@@ -3,29 +3,46 @@
  2. Recent articles template (when the cardView option is enabled)
  3. Shortcode list.html
 */}}
-{{ $disableImageOptimization := .Page.Site.Params.disableImageOptimization | default false }}
+{{ $disableImageOptimization := site.Store.Get "disableImageOptimization" }}

+{{ $page := .Page }}
 {{ $featured := "" }}
 {{ $featuredURL := "" }}
 {{ if not .Params.hideFeatureImage }}
+  {{/* frontmatter */}}
+  {{ with $page }}
    {{ with .Params.featureimage }}
      {{ if or (strings.HasPrefix . "http:") (strings.HasPrefix . "https:") }}
+        {{ if site.Params.hotlinkFeatureImages }}
+          {{ $featuredURL = . }}
+        {{ else }}
          {{ $featured = resources.GetRemote . }}
+        {{ end }}
      {{ else }}
        {{ $featured = resources.Get . }}
      {{ end }}
    {{ end }}

-  {{ if not $featured }}
-    {{ $images := $.Resources.ByType "image" }}
+    {{/* page resources */}}
+    {{ if not (or $featured $featuredURL) }}
+      {{ $images := .Resources.ByType "image" }}
      {{ range slice "*feature*" "*cover*" "*thumbnail*" }}
        {{ if not $featured }}{{ $featured = $images.GetMatch . }}{{ end }}
      {{ end }}
-    {{ if not $featured }}
-      {{ with .Site.Params.defaultFeaturedImage }}{{ $featured = resources.Get . }}{{ end }}
+    {{ end }}
+
+    {{/* fallback to default */}}
+    {{ if not (or $featured $featuredURL) }}
+      {{ $default := site.Store.Get "defaultFeaturedImage" }}
+      {{ if $default.url }}
+        {{ $featuredURL = $default.url }}
+      {{ else if $default.obj }}
+        {{ $featured = $default.obj }}
      {{ end }}
    {{ end }}

+    {{/* generate image URL if not hotlink */}}
+    {{ if not $featuredURL }}
      {{ with $featured }}
        {{ $featuredURL = .RelPermalink }}
        {{ if not (or $disableImageOptimization (eq .MediaType.SubType "svg")) }}
@@ -33,6 +50,8 @@
        {{ end }}
      {{ end }}
    {{ end }}
+  {{ end }}
+{{ end }}


 <article
--- a/layouts/partials/article-link/simple.html
+++ b/layouts/partials/article-link/simple.html
@@ -4,7 +4,7 @@
  3. Shortcode list.html
 */}}
 {{ $constrainItemsWidth := site.Params.list.constrainItemsWidth | default false }}
-{{ $disableImageOptimization := site.Params.disableImageOptimization | default false }}
+{{ $disableImageOptimization := site.Store.Get "disableImageOptimization" }}

 {{ $cardClasses := "flex flex-col md:flex-row relative" }}
 {{ $figureClasses := "" }}
@@ -24,27 +24,44 @@
  {{ $cardClasses = printf "%s max-w-prose" $cardClasses }}
 {{ end }}

+{{ $page := .Page }}
 {{ $featured := "" }}
 {{ $featuredURL := "" }}
 {{ if not .Params.hideFeatureImage }}
+  {{/* frontmatter */}}
+  {{ with $page }}
    {{ with .Params.featureimage }}
      {{ if or (strings.HasPrefix . "http:") (strings.HasPrefix . "https:") }}
+        {{ if site.Params.hotlinkFeatureImages }}
+          {{ $featuredURL = . }}
+        {{ else }}
          {{ $featured = resources.GetRemote . }}
+        {{ end }}
      {{ else }}
        {{ $featured = resources.Get . }}
      {{ end }}
    {{ end }}

-  {{ if not $featured }}
-    {{ $images := $.Resources.ByType "image" }}
+    {{/* page resources */}}
+    {{ if not (or $featured $featuredURL) }}
+      {{ $images := .Resources.ByType "image" }}
      {{ range slice "*feature*" "*cover*" "*thumbnail*" }}
        {{ if not $featured }}{{ $featured = $images.GetMatch . }}{{ end }}
      {{ end }}
-    {{ if not $featured }}
-      {{ with .Site.Params.defaultFeaturedImage }}{{ $featured = resources.Get . }}{{ end }}
+    {{ end }}
+
+    {{/* fallback to default */}}
+    {{ if not (or $featured $featuredURL) }}
+      {{ $default := site.Store.Get "defaultFeaturedImage" }}
+      {{ if $default.url }}
+        {{ $featuredURL = $default.url }}
+      {{ else if $default.obj }}
+        {{ $featured = $default.obj }}
      {{ end }}
    {{ end }}

+    {{/* generate image URL if not hotlink */}}
+    {{ if not $featuredURL }}
      {{ with $featured }}
        {{ $featuredURL = .RelPermalink }}
        {{ if not (or $disableImageOptimization (eq .MediaType.SubType "svg")) }}
@@ -52,6 +69,8 @@
        {{ end }}
      {{ end }}
    {{ end }}
+  {{ end }}
+{{ end }}


 <article class="{{ $cardClasses }}">
--- a/layouts/partials/init.html
+++ b/layouts/partials/init.html
@@ -0,0 +1,34 @@
+{{/* disableImageOptimization */}}
+{{ site.Store.Set "disableImageOptimization" (site.Params.disableImageOptimization | default false) }}
+
+{{/* defaultFeaturedImage */}}
+{{ $defaultFeaturedImage := "" }}
+{{ $defaultFeaturedImageURL := "" }}
+{{ with site.Params.defaultFeaturedImage }}
+  {{ if or (strings.HasPrefix . "http:") (strings.HasPrefix . "https:") }}
+    {{ if site.Params.hotlinkFeatureImages }}
+      {{ $defaultFeaturedImageURL = . }}
+    {{ else }}
+      {{ $defaultFeaturedImage = resources.GetRemote . }}
+    {{ end }}
+  {{ else }}
+    {{ $defaultFeaturedImage = resources.Get . }}
+  {{ end }}
+{{ end }}
+{{ site.Store.Set "defaultFeaturedImage" (dict "url" $defaultFeaturedImageURL "obj" $defaultFeaturedImage) }}
+
+{{/* defaultBackgroundImage */}}
+{{ $defaultBackgroundImage := "" }}
+{{ $defaultBackgroundImageURL := "" }}
+{{ with site.Params.defaultBackgroundImage }}
+  {{ if or (strings.HasPrefix . "http:") (strings.HasPrefix . "https:") }}
+    {{ if site.Params.hotlinkFeatureImages }}
+      {{ $defaultBackgroundImageURL = . }}
+    {{ else }}
+      {{ $defaultBackgroundImage = resources.GetRemote . }}
+    {{ end }}
+  {{ else }}
+    {{ $defaultBackgroundImage = resources.Get . }}
+  {{ end }}
+{{ end }}
+{{ site.Store.Set "defaultBackgroundImage" (dict "url" $defaultBackgroundImageURL "obj" $defaultBackgroundImage) }}