From 24726ef4b07542ec6537431e432830c258cfc748 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Tue, 27 Aug 2024 00:35:12 +0200 Subject: [PATCH] search: index file rename #888 --- .../{_relearn_search_index.js => _relearn_searchindex.js} | 2 +- exampleSite/config/_default/params.toml | 6 +++--- exampleSite/content/basics/customization/_index.en.md | 2 +- layouts/partials/search.html | 4 ++-- static/js/search.js | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) rename assets/{_relearn_search_index.js => _relearn_searchindex.js} (92%) diff --git a/assets/_relearn_search_index.js b/assets/_relearn_searchindex.js similarity index 92% rename from assets/_relearn_search_index.js rename to assets/_relearn_searchindex.js index 243a4c70c3..ee709ff98a 100644 --- a/assets/_relearn_search_index.js +++ b/assets/_relearn_searchindex.js @@ -16,4 +16,4 @@ ) }} {{- end }} {{- end -}} -var relearn_search_index = {{ $pages | jsonify (dict "indent" " ") }} +var relearn_searchindex = {{ $pages | jsonify (dict "indent" " ") }} diff --git a/exampleSite/config/_default/params.toml b/exampleSite/config/_default/params.toml index ee1aec258f..cd59d03954 100644 --- a/exampleSite/config/_default/params.toml +++ b/exampleSite/config/_default/params.toml @@ -157,10 +157,10 @@ disableSearch = false disableSearchIndex = false # URL of the search index file relative to the language home. -# Default: "search_index.js" +# Default: "searchindex.js" # You have to set this option if your page already has a content file named -# `search_index.js` in the language home. -searchIndexURL = "search_index.js" +# `searchindex.js` in the language home. +searchIndexURL = "searchindex.js" # Disable the dedicated search page. # Default: false diff --git a/exampleSite/content/basics/customization/_index.en.md b/exampleSite/content/basics/customization/_index.en.md index a3678227f1..62c588930f 100644 --- a/exampleSite/content/basics/customization/_index.en.md +++ b/exampleSite/content/basics/customization/_index.en.md @@ -73,7 +73,7 @@ By default all three levels are enabled. You can disable each level by the follo By default the following files will be created for each level, relative to each languages home page but can be overwritten: -- search popup: `search_index.js`, configured by `searchIndexURL` +- search popup: `searchindex.js`, configured by `searchIndexURL` - dedicated search page: either `/search.html` or `search/index.html` depending on your settings for `uglyURLs`, configured by `searchPageURL` {{% notice note %}} diff --git a/layouts/partials/search.html b/layouts/partials/search.html index f31ecd9dc8..edcdeed866 100644 --- a/layouts/partials/search.html +++ b/layouts/partials/search.html @@ -8,8 +8,8 @@ {{- warnf "UNSUPPORTED usage of 'searchpage' output format found, remove it from your config; see https://mcshelby.github.io/hugo-theme-relearn/basics/migration#700" }} {{- end }} {{- if not .Site.Params.disableSearchIndex }} - {{- $url := path.Join .Site.LanguagePrefix (trim (or .Site.Params.searchIndexURL "search_index.js") "/") }} - {{- $templateres := resources.Get "_relearn_search_index.js" }} + {{- $url := path.Join .Site.LanguagePrefix (trim (or .Site.Params.searchIndexURL "searchindex.js") "/") }} + {{- $templateres := resources.Get "_relearn_searchindex.js" }} {{- $resultres := $templateres | resources.ExecuteAsTemplate $url .Site.Home }} {{- /* the following code causes Hugo to generate our file - although it is in comments */}}