From 314e744ac43dc8ddfee7d25c07918e4a66ec89c2 Mon Sep 17 00:00:00 2001 From: Chris Abraham Date: Mon, 18 Mar 2024 19:40:00 +0700 Subject: [PATCH 1/6] Implement PageFind search Signed-off-by: Chris Abraham --- assets/js/search.js | 44 ++++++++++++++++++++++++++++ assets/scss/_search.scss | 11 +++++++ config.toml | 2 +- layouts/_default/content.html | 2 +- layouts/_default/search.html | 47 ++++++++++++++++++++++-------- layouts/partials/search-input.html | 31 -------------------- 6 files changed, 92 insertions(+), 45 deletions(-) create mode 100644 assets/js/search.js diff --git a/assets/js/search.js b/assets/js/search.js new file mode 100644 index 0000000000..47a71fa15a --- /dev/null +++ b/assets/js/search.js @@ -0,0 +1,44 @@ +/* +Copyright 2018 Google LLC + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +(function($) { + + 'use strict'; + + var Search = { + init: function() { + $(document).ready(function() { + $(document).on('keypress', '.td-search-input', function(e) { + if (e.keyCode !== 13) { + return + } + + var query = $(this).val(); + var searchPage = "{{ "search/" | relLangURL }}?q=" + query; + console.log(searchPage); + document.location = searchPage; + + return false; + }); + + }); + }, + }; + + Search.init(); + + +}(jQuery)); diff --git a/assets/scss/_search.scss b/assets/scss/_search.scss index 11748925a9..50bb155ab8 100644 --- a/assets/scss/_search.scss +++ b/assets/scss/_search.scss @@ -100,3 +100,14 @@ } } + +.pagefind-ui__result-link { + color: $link-color !important; +} +.pagefind-ui__search-clear { + padding-left: 20px !important; + padding-right: 20px !important; +} +#search { + margin-top: 40px; +} diff --git a/config.toml b/config.toml index e37e0d679d..36c1b16c62 100644 --- a/config.toml +++ b/config.toml @@ -226,7 +226,7 @@ github_repo = "https://github.com/cncf/glossary" github_branch = "main" # Google Custom Search Engine ID. Remove or comment out to disable search. -gcs_engine_id = "eda0239a7d3fd0d90" +# gcs_engine_id = "eda0239a7d3fd0d90" # Enable Algolia DocSearch algolia_docsearch = false diff --git a/layouts/_default/content.html b/layouts/_default/content.html index 85cb48e4b6..c900d77e70 100644 --- a/layouts/_default/content.html +++ b/layouts/_default/content.html @@ -1,4 +1,4 @@ -
+

{{ .Title }}

{{ with .Params.description }}
{{ . | markdownify }}
{{ end }}
diff --git a/layouts/_default/search.html b/layouts/_default/search.html index 2f80b87595..da6425fe46 100644 --- a/layouts/_default/search.html +++ b/layouts/_default/search.html @@ -1,19 +1,42 @@ {{ define "main" }}

{{ .Title }}

- {{ with .Site.Params.gcs_engine_id }} + + + + + + + - - {{ end }} +
{{ end }} diff --git a/layouts/partials/search-input.html b/layouts/partials/search-input.html index 67b31b1030..e9dfee8641 100644 --- a/layouts/partials/search-input.html +++ b/layouts/partials/search-input.html @@ -1,35 +1,4 @@ -{{ if or .Site.Params.gcs_engine_id .Site.Params.algolia_docsearch }}
-{{ else if .Site.Params.offlineSearch }} -{{ $offlineSearchIndex := resources.Get "json/offline-search-index.json" | resources.ExecuteAsTemplate "offline-search-index.json" . }} -{{ $offlineSearchLink := $offlineSearchIndex.RelPermalink -}} -{{ if hugo.IsProduction -}} -{{/* Use `md5` as finger print hash function to shorten file name to avoid `file name too long` error. */}} -{{ $offlineSearchIndexFingerprint := $offlineSearchIndex | resources.Fingerprint "md5" }} -{{ $offlineSearchLink = $offlineSearchIndexFingerprint.RelPermalink -}} -{{ end -}} - -
- - -
-{{ end }} From 4dd22338d0df21ca9dc6ea9d98e6de3290382fdc Mon Sep 17 00:00:00 2001 From: Chris Abraham Date: Sun, 24 Mar 2024 09:00:25 +0700 Subject: [PATCH 2/6] Fixes language-specific search page issue (#2087) Signed-off-by: Chris Abraham --- assets/js/search.js | 3 +-- layouts/partials/search-input.html | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/assets/js/search.js b/assets/js/search.js index 47a71fa15a..42250f4e94 100644 --- a/assets/js/search.js +++ b/assets/js/search.js @@ -27,8 +27,7 @@ limitations under the License. } var query = $(this).val(); - var searchPage = "{{ "search/" | relLangURL }}?q=" + query; - console.log(searchPage); + var searchPage = $(this).data('search-page') + "?q=" + query; document.location = searchPage; return false; diff --git a/layouts/partials/search-input.html b/layouts/partials/search-input.html index e9dfee8641..c062f00513 100644 --- a/layouts/partials/search-input.html +++ b/layouts/partials/search-input.html @@ -1,4 +1,4 @@
- +
From c61847077c5b4b7becfb924d552a570f4aa01144 Mon Sep 17 00:00:00 2001 From: Chris Abraham Date: Sun, 24 Mar 2024 12:27:50 +0700 Subject: [PATCH 3/6] Try to get the build working with PageFind Signed-off-by: Chris Abraham --- Makefile | 28 ++++++++++++++++++++++++++++ netlify.toml | 12 +++++++++++- 2 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000000..f4cb3e0240 --- /dev/null +++ b/Makefile @@ -0,0 +1,28 @@ +serve: + hugo server \ + --disableFastRender \ + --buildDrafts \ + --buildFuture \ + --ignoreCache + --printI18nWarnings \ + --printMemoryUsage \ + --printPathWarnings \ + --printUnusedTemplates \ + --templateMetrics \ + --templateMetricsHints \ + --gc + +production-build: + git submodule update --init --recursive + hugo \ + --minify + npx -y pagefind --site public + +preview-build: + git submodule update --init --recursive + hugo \ + --baseURL $(DEPLOY_PRIME_URL) \ + --buildDrafts \ + --buildFuture \ + --minify + npx -y pagefind --site public \ No newline at end of file diff --git a/netlify.toml b/netlify.toml index 88ed32f16c..82a9c7912f 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,3 +1,7 @@ +[build] +publish = "public" +command = "make production-build" + [build.environment] NODE_VERSION = "18.16.1" HUGO_VERSION = "0.115.2" @@ -6,4 +10,10 @@ HUGO_VERSION = "0.115.2" HUGO_ENV = "production" [context.deploy-preview.environment] -HUGO_ENV = "preview" \ No newline at end of file +HUGO_ENV = "preview" + +[context.deploy-preview] +command = "make preview-build" + +[context.branch-deploy] +command = "make preview-build" \ No newline at end of file From 3f64df2c8d409e5de806a0020cc498ed7984209a Mon Sep 17 00:00:00 2001 From: Chris Abraham Date: Sun, 24 Mar 2024 13:10:41 +0700 Subject: [PATCH 4/6] Updates local build to include search Signed-off-by: Chris Abraham --- .gitignore | 1 + README.md | 2 +- package.json | 3 ++- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 410a3b8e40..360dcc9d3b 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ resources/ node_modules/ .hugo_build.lock .DS_Store +pagefind # Local Netlify folder .netlify diff --git a/README.md b/README.md index f3da6caeb1..9be4799b17 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,6 @@ git submodule update --init --recursive npm install ``` -You can then run the site using `npm run serve` (select "[Hugo]"). +You can then run the site using `npm run serve` (select "[Hugo]"). To have the site run locally with a functioning local search, run `npm run serve:with-pagefind`. [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?repo=cncf/glossary) diff --git a/package.json b/package.json index 67652f00c2..e621adc2ca 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,8 @@ "main": "none.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "serve": "netlify dev -c \"hugo serve --minify -DFE -w\"" + "serve": "netlify dev -c \"hugo serve --minify -DFE -w\"", + "serve:with-pagefind": "hugo --baseURL=/ --theme=docsy && npm_config_yes=true npx pagefind --site 'public' --output-subdir '../static/pagefind' && npm run serve" }, "repository": { "type": "git", From 0855a26ab15c0d7cd25d9912d111dc90453d6233 Mon Sep 17 00:00:00 2001 From: Chris Abraham Date: Mon, 25 Mar 2024 14:20:34 +0700 Subject: [PATCH 5/6] Added search content files in each translation ready to be translated Signed-off-by: Chris Abraham --- content/de/search.md | 4 ++++ content/hi/search.md | 4 ++++ content/it/search.md | 4 ++++ content/ja/search.md | 4 ++++ content/ko/search.md | 4 ++++ content/pt-br/search.md | 4 ++++ content/tr/search.md | 4 ++++ content/ur/search.md | 4 ++++ content/zh-cn/search.md | 4 ++++ content/zh-tw/search.md | 4 ++++ 10 files changed, 40 insertions(+) create mode 100644 content/de/search.md create mode 100644 content/hi/search.md create mode 100644 content/it/search.md create mode 100644 content/ja/search.md create mode 100644 content/ko/search.md create mode 100644 content/pt-br/search.md create mode 100644 content/tr/search.md create mode 100644 content/ur/search.md create mode 100644 content/zh-cn/search.md create mode 100644 content/zh-tw/search.md diff --git a/content/de/search.md b/content/de/search.md new file mode 100644 index 0000000000..d9a4d5beef --- /dev/null +++ b/content/de/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- \ No newline at end of file diff --git a/content/hi/search.md b/content/hi/search.md new file mode 100644 index 0000000000..d9a4d5beef --- /dev/null +++ b/content/hi/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- \ No newline at end of file diff --git a/content/it/search.md b/content/it/search.md new file mode 100644 index 0000000000..d9a4d5beef --- /dev/null +++ b/content/it/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- \ No newline at end of file diff --git a/content/ja/search.md b/content/ja/search.md new file mode 100644 index 0000000000..d9a4d5beef --- /dev/null +++ b/content/ja/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- \ No newline at end of file diff --git a/content/ko/search.md b/content/ko/search.md new file mode 100644 index 0000000000..d9a4d5beef --- /dev/null +++ b/content/ko/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- \ No newline at end of file diff --git a/content/pt-br/search.md b/content/pt-br/search.md new file mode 100644 index 0000000000..d9a4d5beef --- /dev/null +++ b/content/pt-br/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- \ No newline at end of file diff --git a/content/tr/search.md b/content/tr/search.md new file mode 100644 index 0000000000..d9a4d5beef --- /dev/null +++ b/content/tr/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- \ No newline at end of file diff --git a/content/ur/search.md b/content/ur/search.md new file mode 100644 index 0000000000..d9a4d5beef --- /dev/null +++ b/content/ur/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- \ No newline at end of file diff --git a/content/zh-cn/search.md b/content/zh-cn/search.md new file mode 100644 index 0000000000..d9a4d5beef --- /dev/null +++ b/content/zh-cn/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- \ No newline at end of file diff --git a/content/zh-tw/search.md b/content/zh-tw/search.md new file mode 100644 index 0000000000..d9a4d5beef --- /dev/null +++ b/content/zh-tw/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- \ No newline at end of file From a2de621f458512259f4f88e094a6a9ce0c86cb4e Mon Sep 17 00:00:00 2001 From: Chris Abraham Date: Mon, 25 Mar 2024 15:10:57 +0700 Subject: [PATCH 6/6] Updates querystring to match what is being searched so we have a permalink of the search Signed-off-by: Chris Abraham --- layouts/_default/search.html | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/layouts/_default/search.html b/layouts/_default/search.html index da6425fe46..2772fa47ff 100644 --- a/layouts/_default/search.html +++ b/layouts/_default/search.html @@ -31,11 +31,32 @@

{{ .Title }}

const q = urlParams.get('q'); if(q){ setTimeout(function(){ - console.log('Searching:'+q); pagefind.triggerSearch(q); }, 1000); } + + $("#search input").on("input", function() { + var inputValue = $(this).val(); + var queryStringVar = "q"; + updateQueryString(queryStringVar, inputValue); + }); }); + + function updateQueryString(key, value) { + var baseUrl = window.location.href.split("?")[0]; + var queryString = window.location.search.slice(1); + var urlParams = new URLSearchParams(queryString); + + if (urlParams.has(key)) { + urlParams.set(key, value); + } else { + urlParams.append(key, value); + } + + var newUrl = baseUrl + "?" + urlParams.toString(); + // Update the browser history (optional) + window.history.pushState({}, null, newUrl); + }