mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-27 10:43:19 +00:00
Merge branch 'improve-search' of git://github.com/helfper/hugo-theme-relearn into helfper-improve-search
This commit is contained in:
commit
60920f6e20
2 changed files with 46 additions and 38 deletions
|
@ -43,4 +43,6 @@
|
||||||
|
|
||||||
.autocomplete-suggestion > .context {
|
.autocomplete-suggestion > .context {
|
||||||
font-size: 12px;
|
font-size: 12px;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,9 +1,5 @@
|
||||||
var lunrIndex, pagesIndex;
|
var lunrIndex, pagesIndex;
|
||||||
|
|
||||||
function endsWith(str, suffix) {
|
|
||||||
return str.indexOf(suffix, str.length - suffix.length) !== -1;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Initialize lunrjs using our generated index file
|
// Initialize lunrjs using our generated index file
|
||||||
function initLunr() {
|
function initLunr() {
|
||||||
// First retrieve the index file
|
// First retrieve the index file
|
||||||
|
@ -13,75 +9,85 @@ function initLunr() {
|
||||||
// Set up lunrjs by declaring the fields we use
|
// Set up lunrjs by declaring the fields we use
|
||||||
// Also provide their boost level for the ranking
|
// Also provide their boost level for the ranking
|
||||||
lunrIndex = lunr(function() {
|
lunrIndex = lunr(function() {
|
||||||
this.ref("uri");
|
this.ref('index');
|
||||||
this.field('title', {
|
this.field('title', {
|
||||||
boost: 15
|
boost: 15
|
||||||
});
|
});
|
||||||
this.field('tags', {
|
this.field('tags', {
|
||||||
boost: 10
|
boost: 10
|
||||||
});
|
});
|
||||||
this.field("content", {
|
this.field('content', {
|
||||||
boost: 5
|
boost: 5
|
||||||
});
|
});
|
||||||
|
|
||||||
this.pipeline.remove(lunr.stemmer);
|
this.pipeline.remove(lunr.stemmer);
|
||||||
this.searchPipeline.remove(lunr.stemmer);
|
this.searchPipeline.remove(lunr.stemmer);
|
||||||
|
|
||||||
// Feed lunr with each file and let lunr actually index them
|
// Feed lunr with each file and let lunr actually index them
|
||||||
pagesIndex.forEach(function(page) {
|
pagesIndex.forEach(function(page, idx) {
|
||||||
this.add(page);
|
page.index = idx;
|
||||||
|
this.add(page);
|
||||||
}, this);
|
}, this);
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
.fail(function(jqxhr, textStatus, error) {
|
.fail(function(jqxhr, textStatus, error) {
|
||||||
var err = textStatus + ", " + error;
|
var err = textStatus + ', ' + error;
|
||||||
console.error("Error getting Hugo index file:", err);
|
console.error('Error getting Hugo index file:', err);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Trigger a search in lunr and transform the result
|
* Trigger a search in lunr and transform the result
|
||||||
*
|
*
|
||||||
* @param {String} query
|
* @param {String} term
|
||||||
* @return {Array} results
|
* @return {Array} results
|
||||||
*/
|
*/
|
||||||
function search(queryTerm) {
|
function search(term) {
|
||||||
// Find the item in our index corresponding to the lunr one to have more info
|
// Find the item in our index corresponding to the lunr one to have more info
|
||||||
var searchTerm = queryTerm.match(/\w+/g).map(word => word+"^100"+" "+word+"*^10"+" "+"*"+word+"^10"+" "+word+"~2^1").join(" ");
|
// Remove Lunr special search characters: https://lunrjs.com/guides/searching.html
|
||||||
return lunrIndex.search(searchTerm).map(function(result) {
|
var searchTerm = lunr.tokenizer(term.replace(/[*:^~+-]/, ' ')).flatMap(token => searchPatterns(token.str)).join(' ');
|
||||||
return pagesIndex.filter(function(page) {
|
return !searchTerm ? [] : lunrIndex.search(searchTerm).map(function(result) {
|
||||||
return page.uri === result.ref;
|
return { index: result.ref, matches: Object.keys(result.matchData.metadata) }
|
||||||
})[0];
|
});
|
||||||
});
|
}
|
||||||
|
|
||||||
|
function searchPatterns(word) {
|
||||||
|
return [
|
||||||
|
word + '^100',
|
||||||
|
word + '*^10',
|
||||||
|
'*' + word + '^10',
|
||||||
|
word + '~' + Math.floor(word.length / 4) + '^1' // allow 1 in 4 letters to have a typo
|
||||||
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
// Let's get started
|
// Let's get started
|
||||||
initLunr();
|
initLunr();
|
||||||
$( document ).ready(function() {
|
$(function() {
|
||||||
var searchList = new autoComplete({
|
var searchList = new autoComplete({
|
||||||
/* selector for the search box element */
|
/* selector for the search box element */
|
||||||
selector: $("#search-by").get(0),
|
selector: $('#search-by').get(0),
|
||||||
/* source is the callback to perform the search */
|
/* source is the callback to perform the search */
|
||||||
source: function(term, response) {
|
source: function(term, response) {
|
||||||
response(search(term));
|
response(search(term));
|
||||||
},
|
},
|
||||||
/* renderItem displays individual search results */
|
/* renderItem displays individual search results */
|
||||||
renderItem: function(item, term) {
|
renderItem: function(item, term) {
|
||||||
|
var page = pagesIndex[item.index];
|
||||||
var numContextWords = 2;
|
var numContextWords = 2;
|
||||||
var text = item.content.match(
|
var contextPattern = '(?:\\S+ +){0,' + numContextWords + '}\\S*\\b(?:' +
|
||||||
"(?:\\s?(?:[\\w]+)\\s?){0,"+numContextWords+"}" +
|
item.matches.map(match => match.replace(/\W/g, '\\$&')).join('|') +
|
||||||
term.trim()+"(?:\\s?(?:[\\w]+)\\s?){0,"+numContextWords+"}");
|
')\\b\\S*(?: +\\S+){0,' + numContextWords + '}';
|
||||||
item.context = text;
|
var context = page.content.match(new RegExp(contextPattern, 'i'));
|
||||||
var divcontext = document.createElement("div");
|
var divcontext = document.createElement('div');
|
||||||
divcontext.className = "context";
|
divcontext.className = 'context';
|
||||||
divcontext.innerText = (item.context || '');
|
divcontext.innerText = (context || '');
|
||||||
var divsuggestion = document.createElement("div");
|
var divsuggestion = document.createElement('div');
|
||||||
divsuggestion.className = "autocomplete-suggestion";
|
divsuggestion.className = 'autocomplete-suggestion';
|
||||||
divsuggestion.setAttribute("data-term", term);
|
divsuggestion.setAttribute('data-term', term);
|
||||||
divsuggestion.setAttribute("data-title", item.title);
|
divsuggestion.setAttribute('data-title', page.title);
|
||||||
divsuggestion.setAttribute("data-uri", baseUri + item.uri);
|
divsuggestion.setAttribute('data-uri', baseUri + page.uri);
|
||||||
divsuggestion.setAttribute("data-context", item.context);
|
divsuggestion.setAttribute('data-context', context);
|
||||||
divsuggestion.innerText = '» ' + item.title;
|
divsuggestion.innerText = '» ' + page.title;
|
||||||
divsuggestion.appendChild(divcontext);
|
divsuggestion.appendChild(divcontext);
|
||||||
return divsuggestion.outerHTML;
|
return divsuggestion.outerHTML;
|
||||||
},
|
},
|
||||||
|
@ -93,6 +99,6 @@ $( document ).ready(function() {
|
||||||
|
|
||||||
// JavaScript-autoComplete only registers the focus event when minChars is 0 which doesn't make sense, let's do it ourselves
|
// JavaScript-autoComplete only registers the focus event when minChars is 0 which doesn't make sense, let's do it ourselves
|
||||||
// https://github.com/Pixabay/JavaScript-autoComplete/blob/master/auto-complete.js#L191
|
// https://github.com/Pixabay/JavaScript-autoComplete/blob/master/auto-complete.js#L191
|
||||||
var selector = $("#search-by").get(0);
|
var selector = $('#search-by').get(0);
|
||||||
$(selector).focus(selector.focusHandler);
|
$(selector).focus(selector.focusHandler);
|
||||||
});
|
});
|
||||||
|
|
Loading…
Reference in a new issue