feat[layouts/ static/]: Added search functionality

Ripped off the onion theme from heracl.es
This commit is contained in:
Judah Sotomayor 2023-10-15 00:17:04 -04:00
parent 8fe79685e2
commit 06eba57815
13 changed files with 2835 additions and 35 deletions

View File

@ -0,0 +1,22 @@
<!DOCTYPE html>
{{ partial "head.html" . }}
<html>
{{ partial "page_header.html" . }}
<body>
<h1>{{ block "title" .}}
{{ .Title | title }}
{{- end }}
</h1>
<!-- Code that all your templates share, like a header -->
{{ block "main" . }}
{{ .Content }}
<!-- The part of the page that begins to differ between templates -->
{{ end }}
{{ block "footer" . }}
<!-- More shared code, perhaps a footer but that can be overridden if need be in -->
{{ end }}
</body>
</html>

View File

@ -0,0 +1,15 @@
{{/* layouts/_default/index.json */}}
{{- $index := slice -}}
{{- range where .Site.RegularPages.ByDate.Reverse "Type" "not in" (slice "page" "json") -}}
{{ if .Params.dateCreated }}
{{ $.Scratch.Set "date" (.Params.dateCreated) }}
{{ else }}
{{- if isset site.Params "date_format" -}}
{{- $.Scratch.Set "date" (.Date.Format site.Params.date_format) -}}
{{- else -}}
{{- $.Scratch.Set "date" (.Date.Format "2006-01-02") -}}
{{- end -}}
{{ end }}
{{- $index = $index | append (dict "title" ( .Title | plainify ) "permalink" .Permalink "section" (i18n (.Section | title)) "tags" (apply .Params.tags "i18n" "." ) "categories" (apply .Params.categories "i18n" "." ) "summary" (.Params.summary | markdownify | htmlUnescape | plainify) "date" ($.Scratch.Get "date") ) -}}
{{- end -}}
{{- $index | jsonify -}}

View File

@ -1,23 +1,19 @@
<!DOCTYPE html>
<html>
{{ partial "head.html" . }}
{{ define "main" -}}
<body>
{{ partial "page_header.html" . }}
<h3>Posts</h3>
<div>
<!-- orders content according to the "publishdate" field in front matter -->
{{ range .Pages.ByPublishDate }}
<div>
<a href="{{ .Permalink }}">{{ .Title }}</a><br />
<time>{{ .Date.Format "January 2, 2006" }}</time>
</div>
<br />
{{ .Content }}
<ul>
{{- range.Pages }}
<li>
{{- if .Param "datesinlist" }}<time datetime="{{ .Date.Format "2006-01-02T15:04:05Z07:00" }}">{{ .Date.Format "2006 Jan 02" }}</time> &ndash; {{ end -}}
<a href="{{ .RelPermalink }}">{{ .Title }}</a>
{{- if .Param "authorsinlist" }}
{{ with .Params.authors }}
by
{{ delimit . ", " " and " }}
{{end}}
</div>
</body>
{{ end -}}
</li>
{{- end }}
</ul>
{{- end }}
</html>

View File

@ -1,13 +1,10 @@
<!DOCTYPE html>
{{ partial "head.html" . }}
<html>
{{ partial "page_header.html" . }}
<h1>{{ .Title }}</h1>
{{ define "main" }}
<p class="post-meta"><time itemprop="datePublished">{{ .Date.Format "January 2, 2006" }}</time>
</p>
{{ .Content }}
{{ end }}
{{ partial "footer.html" . }}
</html>
{{ define "footer" }}
{{partial "footer" .}}
{{ end }}

View File

@ -1,4 +1,5 @@
<head>
<title>{{ if not .IsHome }}{{ .Title | title }} | {{ end }}{{ .Site.Title }}</title>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
@ -12,4 +13,6 @@
integrity="sha384-oS3vJWv+0UjzBfQzYUhtDYW+Pj2yciDJxpsK1OYPAYjqT085Qq/1cq5FLXAZQ7Ay" crossorigin="anonymous">
<script src="/js/dark.js" defer=""></script>
{{ partialCached "search" . }}
</head>

View File

@ -3,7 +3,6 @@
<body>
<header class="site-header">
<div class="wrapper">
<a class="muted small" href="{{ .Site.BaseURL }}">{{ .Site.Params.Name }}</a>
</div>

View File

@ -0,0 +1,21 @@
<!-- layouts/partials/search.html -->
<form id="search__form" class="noscript" method="GET" action="https://duckduckgo.com/" data-language-prefix="{{ site.LanguagePrefix }}">
<div class="search__bar">
<input id="search__input" class="muted" name="q" tabindex="0" autocomplete="off" {{ with site.BaseURL }}value="Ctrl-/ to search"{{ end }} placeholder="{{ i18n "search" }}">
<!-- label id="search__button" for="search__input" class="icon" type="button"><span>⌕</span></label>-->
</div>
<div id="search__results" class="articles-list"></div>
</form>
<script src="{{ "/scripts/askolonion/askolonion.js" }}"></script>
<style>
#search__form {
float: right;
padding: 30px;
}
#search__input {
}
</style>

View File

@ -1,9 +1,9 @@
body {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
line-height: 1.5em;
font-size: 1.1em;
font-size: 2.1em;
color: #222;
max-width: 40rem;
max-width: 90%;
padding: 2rem;
margin: auto;
background: #fafafa;
@ -39,3 +39,4 @@ hr {
border: 0px;
border: 1px solid #eee;
}

View File

@ -0,0 +1,244 @@
// static/scripts/askolonion/askolonion.js
/*--------------------------------------------------------------
askolonion Super fast, client side search for Hugo.io with Fusejs.io
based on https://gist.github.com/cmod/5410eae147e4318164258742dd053993
--------------------------------------------------------------*/
if (typeof variable !== 'undefined') {
console.log('askolonion.js already loaded');
} else {
askolonion = function(){
var search__form = document.getElementById('search__form'); // search form
var search__input = document.getElementById('search__input'); // input box for search
var search__button = document.getElementById('search__button'); // form submit button
var search__results = document.getElementById('search__results'); // targets the <ul>
var fuse; // holds our search engine
var search__focus = false; // check to true to make visible by default
var results_available = false; // did we get any search results?
var first_run = true; // allow us to delay loading json data unless search activated
var first = search__results.firstChild; // first child of search list
var last = search__results.lastChild; // last child of search list
search__form.classList.remove('noscript'); // JavaScript is active
search__form.setAttribute('data-focus', search__focus);
/*--------------------------------------------------------------
The main keyboard event listener running the show
--------------------------------------------------------------*/
document.addEventListener('keydown', function(e) {
// console.log(event); // DEBUG
// Ctrl + / to show or hide Search
// if (event.which === 191) { // Key: /
if (event.ctrlKey && event.which === 191) { // Key: Ctrl + /
search_toggle_focus(e); // toggle visibility of search box
}
});
/*--------------------------------------------------------------
The main keyboard event listener running the show
--------------------------------------------------------------*/
search__form.addEventListener('keydown', function(e) {
// Allow ESC (27) to close search box
if (e.keyCode == 27) {
search__focus = true; // make sure toggle removes focus
search_toggle_focus(e);
}
// DOWN (40) arrow
if (e.keyCode == 40) {
if (results_available) {
e.preventDefault(); // stop window from scrolling
if ( document.activeElement == search__input) { first.focus(); } // if the currently focused element is the main input --> focus the first <li>
else if ( document.activeElement == last ) { first.focus(); } // if we're at the bottom, loop to the start
// else if ( document.activeElement == last ) { last.focus(); } // if we're at the bottom, stay there
else { document.activeElement.parentElement.nextSibling.firstElementChild.focus(); } // otherwise select the next search result
}
}
// UP (38) arrow
if (e.keyCode == 38) {
if (results_available) {
e.preventDefault(); // stop window from scrolling
if ( document.activeElement == search__input) { search__input.focus(); } // If we're in the input box, do nothing
else if ( document.activeElement == first) { search__input.focus(); } // If we're at the first item, go to input box
else { document.activeElement.parentElement.previousSibling.firstElementChild.focus(); } // Otherwise, select the search result above the current active one
}
}
// Use Enter (13) to move to the first result
if (e.keyCode == 13) {
e.preventDefault(); // stop form from being submitted
if (results_available && document.activeElement == search__input) {
first.focus();
} else {
e.preventDefault();
}
}
// Use Backspace (8) to switch back to the search input
if (e.keyCode == 8) {
if (document.activeElement != search__input) {
e.preventDefault(); // stop browser from going back in history
search__input.focus();
}
}
});
/*--------------------------------------------------------------
Load our json data and builds fuse.js search index
--------------------------------------------------------------*/
search__form.addEventListener('focusin', function(e) {
search_init(); // try to load the search index
});
/*--------------------------------------------------------------
Make button toggle focus
--------------------------------------------------------------*/
search__button.addEventListener('mousedown', function(e) {
search_toggle_focus(e);
e.preventDefault();
e.stopPropagation();
});
/*--------------------------------------------------------------
Remove focus on blur
--------------------------------------------------------------*/
search__form.addEventListener('focusout', function(e) {
if (e.relatedTarget === null) {
search_toggle_focus(e);
}
else if (e.relatedTarget.type === 'submit') {
e.stopPropagation();
}
});
/*--------------------------------------------------------------
Toggle focus UI of form
--------------------------------------------------------------*/
function search_toggle_focus(e) {
// order of operations is very important to keep focus where it should stay
if (!search__focus) {
// search__button.value = '';
search__form.setAttribute('data-focus', true);
search__input.focus(); // move focus to search box
search__focus = true;
}
else {
// search__button.value = '⌕';
search__form.setAttribute('data-focus', false);
document.activeElement.blur(); // remove focus from search box
search__focus = false;
}
// console.log(search__focus,e); // DEBUG
}
/*--------------------------------------------------------------
Fetch some json without jquery
--------------------------------------------------------------*/
function fetch_JSON(path, callback) {
var httpRequest = new XMLHttpRequest();
httpRequest.onreadystatechange = function() {
if (httpRequest.readyState === 4) {
if (httpRequest.status === 200) {
var data = JSON.parse(httpRequest.responseText);
if (callback) callback(data);
}
}
};
httpRequest.open('GET', path);
httpRequest.send();
}
/*--------------------------------------------------------------
Load script
based on https://stackoverflow.com/a/55451823
--------------------------------------------------------------*/
function load_script(url) {
return new Promise(function(resolve, reject) {
let script = document.createElement("script");
script.onerror = reject;
script.onload = resolve;
if (document.currentScript) {
document.currentScript.parentNode.insertBefore(script, document.currentScript);
}
else {
document.head.appendChild(script)
}
script.src = url;
});
}
/*--------------------------------------------------------------
Load our search index, only executed once
on first call of search box (Ctrl + /)
--------------------------------------------------------------*/
function search_init() {
if (first_run) {
load_script(window.location.origin + '/scripts/askolonion/fuse.basic.min.js').then(() => {
search__input.value = ""; // reset default value
first_run = false; // let's never do this again
fetch_JSON(search__form.getAttribute('data-language-prefix') + '/index.json', function(data){
var options = { // fuse.js options; check fuse.js website for details
shouldSort: true,
location: 0,
distance: 100,
threshold: 0.4,
minMatchCharLength: 2,
keys: [
'permalink',
'title',
'date',
'summary',
'section',
'categories',
'tags'
]
};
fuse = new Fuse(data, options); // build the index from the json file
search__input.addEventListener('keyup', function(e) { // execute search as each character is typed
search_exec(this.value);
});
// console.log("index.json loaded"); // DEBUG
});
}).catch((error) => { console.log('askolonion failed to load: ' + error); });
}
}
/*--------------------------------------------------------------
Using the index we loaded on Ctrl + /, run
a search query (for "term") every time a letter is typed
in the search box
--------------------------------------------------------------*/
function search_exec(term) {
let results = fuse.search(term); // the actual query being run using fuse.js
let search_items = ''; // our results bucket
if (results.length === 0) { // no results based on what was typed into the input box
results_available = false;
search_items = '';
} else { // build our html
for (let item in results.slice(0,50)) { // only show first 5 results
search_items = search_items +
`<article><a href="${results[item].item.permalink}" tabindex="0">
<time class="time">${results[item].item.date}</time>
<h3 class="title">${results[item].item.title}</h3>
<p class="summary">${results[item].item.summary}</p>
<span class="section">${results[item].item.section}</span>
<span class="categories">${results[item].item.categories.join(', ')}</span>
<span class="tags">${results[item].item.tags.join(', ')}</span>
</article>`;
}
results_available = true;
}
search__results.innerHTML = search_items;
if (results.length > 0) {
first = search__results.firstChild.firstElementChild; // first result container — used for checking against keyboard up/down location
last = search__results.lastChild.firstElementChild; // last result container — used for checking against keyboard up/down location
}
}
}();
}

File diff suppressed because one or more lines are too long

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,244 @@
// static/scripts/askolonion/askolonion.js
/*--------------------------------------------------------------
askolonion Super fast, client side search for Hugo.io with Fusejs.io
based on https://gist.github.com/cmod/5410eae147e4318164258742dd053993
--------------------------------------------------------------*/
if (typeof variable !== 'undefined') {
console.log('askolonion.js already loaded');
} else {
askolonion = function(){
var search__form = document.getElementById('search__form'); // search form
var search__input = document.getElementById('search__input'); // input box for search
var search__button = document.getElementById('search__button'); // form submit button
var search__results = document.getElementById('search__results'); // targets the <ul>
var fuse; // holds our search engine
var search__focus = false; // check to true to make visible by default
var results_available = false; // did we get any search results?
var first_run = true; // allow us to delay loading json data unless search activated
var first = search__results.firstChild; // first child of search list
var last = search__results.lastChild; // last child of search list
search__form.classList.remove('noscript'); // JavaScript is active
search__form.setAttribute('data-focus', search__focus);
/*--------------------------------------------------------------
The main keyboard event listener running the show
--------------------------------------------------------------*/
document.addEventListener('keydown', function(e) {
// console.log(event); // DEBUG
// Ctrl + / to show or hide Search
// if (event.which === 191) { // Key: /
if (event.ctrlKey && event.which === 191) { // Key: Ctrl + /
search_toggle_focus(e); // toggle visibility of search box
}
});
/*--------------------------------------------------------------
The main keyboard event listener running the show
--------------------------------------------------------------*/
search__form.addEventListener('keydown', function(e) {
// Allow ESC (27) to close search box
if (e.keyCode == 27) {
search__focus = true; // make sure toggle removes focus
search_toggle_focus(e);
}
// DOWN (40) arrow
if (e.keyCode == 40) {
if (results_available) {
e.preventDefault(); // stop window from scrolling
if ( document.activeElement == search__input) { first.focus(); } // if the currently focused element is the main input --> focus the first <li>
else if ( document.activeElement == last ) { first.focus(); } // if we're at the bottom, loop to the start
// else if ( document.activeElement == last ) { last.focus(); } // if we're at the bottom, stay there
else { document.activeElement.parentElement.nextSibling.firstElementChild.focus(); } // otherwise select the next search result
}
}
// UP (38) arrow
if (e.keyCode == 38) {
if (results_available) {
e.preventDefault(); // stop window from scrolling
if ( document.activeElement == search__input) { search__input.focus(); } // If we're in the input box, do nothing
else if ( document.activeElement == first) { search__input.focus(); } // If we're at the first item, go to input box
else { document.activeElement.parentElement.previousSibling.firstElementChild.focus(); } // Otherwise, select the search result above the current active one
}
}
// Use Enter (13) to move to the first result
if (e.keyCode == 13) {
e.preventDefault(); // stop form from being submitted
if (results_available && document.activeElement == search__input) {
first.focus();
} else {
e.preventDefault();
}
}
// Use Backspace (8) to switch back to the search input
if (e.keyCode == 8) {
if (document.activeElement != search__input) {
e.preventDefault(); // stop browser from going back in history
search__input.focus();
}
}
});
/*--------------------------------------------------------------
Load our json data and builds fuse.js search index
--------------------------------------------------------------*/
search__form.addEventListener('focusin', function(e) {
search_init(); // try to load the search index
});
/*--------------------------------------------------------------
Make button toggle focus
--------------------------------------------------------------*/
search__button.addEventListener('mousedown', function(e) {
search_toggle_focus(e);
e.preventDefault();
e.stopPropagation();
});
/*--------------------------------------------------------------
Remove focus on blur
--------------------------------------------------------------*/
search__form.addEventListener('focusout', function(e) {
if (e.relatedTarget === null) {
search_toggle_focus(e);
}
else if (e.relatedTarget.type === 'submit') {
e.stopPropagation();
}
});
/*--------------------------------------------------------------
Toggle focus UI of form
--------------------------------------------------------------*/
function search_toggle_focus(e) {
// order of operations is very important to keep focus where it should stay
if (!search__focus) {
// search__button.value = '';
search__form.setAttribute('data-focus', true);
search__input.focus(); // move focus to search box
search__focus = true;
}
else {
// search__button.value = '⌕';
search__form.setAttribute('data-focus', false);
document.activeElement.blur(); // remove focus from search box
search__focus = false;
}
// console.log(search__focus,e); // DEBUG
}
/*--------------------------------------------------------------
Fetch some json without jquery
--------------------------------------------------------------*/
function fetch_JSON(path, callback) {
var httpRequest = new XMLHttpRequest();
httpRequest.onreadystatechange = function() {
if (httpRequest.readyState === 4) {
if (httpRequest.status === 200) {
var data = JSON.parse(httpRequest.responseText);
if (callback) callback(data);
}
}
};
httpRequest.open('GET', path);
httpRequest.send();
}
/*--------------------------------------------------------------
Load script
based on https://stackoverflow.com/a/55451823
--------------------------------------------------------------*/
function load_script(url) {
return new Promise(function(resolve, reject) {
let script = document.createElement("script");
script.onerror = reject;
script.onload = resolve;
if (document.currentScript) {
document.currentScript.parentNode.insertBefore(script, document.currentScript);
}
else {
document.head.appendChild(script)
}
script.src = url;
});
}
/*--------------------------------------------------------------
Load our search index, only executed once
on first call of search box (Ctrl + /)
--------------------------------------------------------------*/
function search_init() {
if (first_run) {
load_script(window.location.origin + '/scripts/askolonion/fuse.basic.min.js').then(() => {
search__input.value = ""; // reset default value
first_run = false; // let's never do this again
fetch_JSON(search__form.getAttribute('data-language-prefix') + '/index.json', function(data){
var options = { // fuse.js options; check fuse.js website for details
shouldSort: true,
location: 0,
distance: 100,
threshold: 0.4,
minMatchCharLength: 2,
keys: [
'permalink',
'title',
'date',
'summary',
'section',
'categories',
'tags'
]
};
fuse = new Fuse(data, options); // build the index from the json file
search__input.addEventListener('keyup', function(e) { // execute search as each character is typed
search_exec(this.value);
});
// console.log("index.json loaded"); // DEBUG
});
}).catch((error) => { console.log('askolonion failed to load: ' + error); });
}
}
/*--------------------------------------------------------------
Using the index we loaded on Ctrl + /, run
a search query (for "term") every time a letter is typed
in the search box
--------------------------------------------------------------*/
function search_exec(term) {
let results = fuse.search(term); // the actual query being run using fuse.js
let search_items = ''; // our results bucket
if (results.length === 0) { // no results based on what was typed into the input box
results_available = false;
search_items = '';
} else { // build our html
for (let item in results.slice(0,50)) { // only show first 5 results
search_items = search_items +
`<article><a href="${results[item].item.permalink}" tabindex="0">
<time class="time">${results[item].item.date}</time>
<h3 class="title">${results[item].item.title}</h3>
<p class="summary">${results[item].item.summary}</p>
<span class="section">${results[item].item.section}</span>
<span class="categories">${results[item].item.categories.join(', ')}</span>
<span class="tags">${results[item].item.tags.join(', ')}</span>
</article>`;
}
results_available = true;
}
search__results.innerHTML = search_items;
if (results.length > 0) {
first = search__results.firstChild.firstElementChild; // first result container — used for checking against keyboard up/down location
last = search__results.lastChild.firstElementChild; // last result container — used for checking against keyboard up/down location
}
}
}();
}

File diff suppressed because one or more lines are too long