Skip to content

fix: publish the search index on Hugo < 0.164 (avoid the PostProcess/Defer clash) #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markdumay merged 1 commit into from
Jul 18, 2026
Merged

fix: publish the search index on Hugo < 0.164 (avoid the PostProcess/Defer clash) #310

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 29 additions & 8 deletions layouts/_partials/assets/search-index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,34 @@
Include it from every template that renders a search UI (search-input.html
and ModalSearch.html do); without at least one inclusion per language the
index asset is not published and the runtime fetch would 404.

Hugo version gate: on Hugo < 0.164 a page that uses `resources.PostProcess`
silently prevents that page's `templates.Defer` blocks from executing — and
the theme's production stylesheet always uses `resources.PostProcess` (it is
how `css.PostCSS` is deferred so PurgeCSS reads a complete hugo_stats.json).
The deferred index would then never publish and its raw placeholder token
would leak into the rendered page. So on Hugo < 0.164 publish the index
EAGERLY instead: correct, at the cost of the serial-render stall that
templates.Defer was introduced to avoid. Guard the eager path to run once
per language via site.Store. Hugo >= 0.164 keeps the deferred path.
(hugo.Version.Compare returns > 0 when the running version is older.)
*/ -}}
{{- with (templates.Defer (dict
"key" (printf "flexsearch-index-%s" site.Language.Lang)
"data" (dict "site" site)
)) -}}
{{- $site := .site -}}
{{- $docs := partial "utilities/GetSearchDocs.html" (dict "site" $site) -}}
{{- $index := resources.FromString (partial "utilities/GetSearchIndexPath.html" $site) ($docs | jsonify) -}}
{{- $noop := $index.RelPermalink -}}
{{- if le (hugo.Version.Compare "0.164.0") 0 -}}
{{- with (templates.Defer (dict
"key" (printf "flexsearch-index-%s" site.Language.Lang)
"data" (dict "site" site)
)) -}}
{{- $site := .site -}}
{{- $docs := partial "utilities/GetSearchDocs.html" (dict "site" $site) -}}
{{- $index := resources.FromString (partial "utilities/GetSearchIndexPath.html" $site) ($docs | jsonify) -}}
{{- $noop := $index.RelPermalink -}}
{{- end -}}
{{- else -}}
{{- $guard := printf "flexsearch-index-eager-%s" site.Language.Lang -}}
{{- if not (site.Store.Get $guard) -}}
{{- site.Store.Set $guard true -}}
{{- $docs := partial "utilities/GetSearchDocs.html" (dict "site" site) -}}
{{- $index := resources.FromString (partial "utilities/GetSearchIndexPath.html" site) ($docs | jsonify) -}}
{{- $noop := $index.RelPermalink -}}
{{- end -}}
{{- end -}}