-
Notifications
You must be signed in to change notification settings - Fork 114
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #363 from cncf/pagefind
Swap in PageFind for Google Custom Search
- Loading branch information
Showing
24 changed files
with
172 additions
and
115 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,2 @@ | ||
[build] | ||
publish = "website/public" | ||
command = "npm run build:preview" | ||
|
||
[context.production] | ||
command = "npm run build:production" | ||
base = "website" |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
pagefind |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
/* | ||
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 = $(this).data('search-page') + "?q=" + query; | ||
document.location = searchPage; | ||
|
||
return false; | ||
}); | ||
|
||
}); | ||
}, | ||
}; | ||
|
||
Search.init(); | ||
|
||
|
||
}(jQuery)); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,63 @@ | ||
{{ define "main" }} | ||
<div> | ||
<h1 class="thin">{{ .Title }}</h2> | ||
{{ with .Site.Params.gcs_engine_id }} | ||
<script> | ||
(function() { | ||
var cx = '{{ . }}'; | ||
var gcse = document.createElement('script'); | ||
gcse.type = 'text/javascript'; | ||
gcse.async = true; | ||
gcse.src = 'https://cse.google.com/cse.js?cx=' + cx; | ||
var s = document.getElementsByTagName('script')[0]; | ||
s.parentNode.insertBefore(gcse, s); | ||
})(); | ||
</script> | ||
<gcse:searchresults-only></gcse:searchresults-only> | ||
{{ end }} | ||
</div> | ||
<h1 class="thin">{{ .Title }}</h1> | ||
|
||
<link href='{{ "/pagefind/pagefind-ui.css" }}' rel="stylesheet"> | ||
|
||
<style> | ||
:root { | ||
--pagefind-ui-scale: 1; | ||
--pagefind-ui-primary: #000; | ||
--pagefind-ui-text: #000; | ||
--pagefind-ui-background: #ffffff; | ||
--pagefind-ui-border: #eeeeee; | ||
--pagefind-ui-tag: #eeeeee; | ||
--pagefind-ui-border-width: 2px; | ||
--pagefind-ui-border-radius: 8px; | ||
--pagefind-ui-image-border-radius: 8px; | ||
--pagefind-ui-image-box-ratio: 3 / 2; | ||
--pagefind-ui-font: 'Clarity City', -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif, Roboto, | ||
Ubuntu, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; | ||
} | ||
</style> | ||
<script src='{{ "/pagefind/pagefind-ui.js" }}' defer></script> | ||
|
||
<div id="search"></div> | ||
<script> | ||
window.addEventListener("DOMContentLoaded", (event) => { | ||
pagefind = new PagefindUI({ element: "#search", showSubResults: true, showImages: false, resetStyles: false }); | ||
|
||
const urlParams = new URLSearchParams(window.location.search); | ||
const q = urlParams.get('q'); | ||
if(q){ | ||
setTimeout(function(){ | ||
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); | ||
} | ||
</script> | ||
|
||
</div> | ||
{{ end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,4 @@ | ||
{{ if or .Site.Params.gcs_engine_id .Site.Params.algolia_docsearch }} | ||
<div class="add-search-icon"> | ||
<input type="search" class="form-control td-search-input" placeholder="{{ T "ui_search" }}" aria-label="{{ T "ui_search" }}" autocomplete="off"> | ||
<svg xmlns="http://www.w3.org/2000/svg" role="img" viewBox="0.88 0.63 32.17 30.24"><g opacity=".945"><path stroke="#000" stroke-width="4.392" d="M13.746 23.279c5.536 0 10.024-4.432 10.024-9.9 0-5.466-4.488-9.898-10.024-9.898-5.536 0-10.024 4.432-10.024 9.899 0 5.467 4.488 9.899 10.024 9.899zm6.56-5.069l10.652 10.52" fill="transparent" /></g></svg> | ||
</div> | ||
{{ 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 -}} | ||
|
||
<div class="add-search-icon"> | ||
<input | ||
type="search" | ||
class="form-control td-search-input" | ||
placeholder="{{ T "ui_search" }}" | ||
aria-label="{{ T "ui_search" }}" | ||
autocomplete="off" | ||
{{/* | ||
The data attribute name of the json file URL must end with `src` since | ||
Hugo's absurlreplacer requires `src`, `href`, `action` or `srcset` suffix for the attribute name. | ||
If the absurlreplacer is not applied, the URL will start with `/`. | ||
It causes the json file loading error when when relativeURLs is enabled. | ||
https://github.com/google/docsy/issues/181 | ||
*/}} | ||
data-offline-search-index-json-src="{{ $offlineSearchLink }}" | ||
data-offline-search-base-href="/" | ||
data-offline-search-max-results="{{ .Site.Params.offlineSearchMaxResults | default 10 }}" | ||
> | ||
<svg xmlns="http://www.w3.org/2000/svg" role="img" viewBox="0.88 0.63 32.17 30.24"><g opacity=".945"><path stroke="#000" stroke-width="4.392" d="M13.746 23.279c5.536 0 10.024-4.432 10.024-9.9 0-5.466-4.488-9.898-10.024-9.898-5.536 0-10.024 4.432-10.024 9.899 0 5.467 4.488 9.899 10.024 9.899zm6.56-5.069l10.652 10.52" fill="transparent" /></g></svg> | ||
</div> | ||
{{ end }} | ||
<input type="search" data-search-page="{{ "search/" | relLangURL }}" class="form-control td-search-input" placeholder="{{ T "ui_search" }}" aria-label="{{ T "ui_search" }}" autocomplete="off"> | ||
<svg xmlns="http://www.w3.org/2000/svg" role="img" viewBox="0.88 0.63 32.17 30.24"><g opacity=".945"><path stroke="#000" stroke-width="4.392" d="M13.746 23.279c5.536 0 10.024-4.432 10.024-9.9 0-5.466-4.488-9.898-10.024-9.898-5.536 0-10.024 4.432-10.024 9.899 0 5.467 4.488 9.899 10.024 9.899zm6.56-5.069l10.652 10.52" fill="transparent" /></g></svg> | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
[build] | ||
publish = "public" | ||
command = "make production-build" | ||
ignore = "exit 1" | ||
|
||
[build.environment] | ||
NODE_VERSION = "18.16.1" | ||
HUGO_VERSION = "0.115.2" | ||
|
||
[context.production.environment] | ||
HUGO_ENV = "production" | ||
|
||
[context.deploy-preview.environment] | ||
HUGO_ENV = "preview" | ||
|
||
[context.deploy-preview] | ||
command = "make preview-build" | ||
|
||
[context.branch-deploy] | ||
command = "make preview-build" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters