From ca4212631ce1c47f0553e974c228e86c1ac88230 Mon Sep 17 00:00:00 2001 From: artaud Date: Fri, 5 Jan 2024 14:27:09 +0100 Subject: [PATCH 1/2] add baseurl to cross references --- _config.yml | 1 + liveserve.sh | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index c6fc63f..be52324 100644 --- a/_config.yml +++ b/_config.yml @@ -56,6 +56,7 @@ asciidoctor: xrefstyle: full imagesdir: '{site-baseurl}/assets/images' iconsdir: '{imagesdir}/../icons' + relfileprefix: '{site-baseurl}' hardbreaks: true icons: '' icontype: svg diff --git a/liveserve.sh b/liveserve.sh index 3fbebff..0d4324c 100755 --- a/liveserve.sh +++ b/liveserve.sh @@ -1 +1 @@ -bundle exec jekyll liveserve \ No newline at end of file +jekyll serve --watch From ff54a15345e32b2f53aca9bc45470ccfdc455d9f Mon Sep 17 00:00:00 2001 From: artaud Date: Sun, 7 Jan 2024 12:21:00 +0100 Subject: [PATCH 2/2] fix search --- _config.yml | 4 +- _sass/search.scss | 12 +++- assets/js/just-the-docs.js | 110 +++++++++++++++++++++++-------------- assets/js/search-data.json | 3 +- 4 files changed, 83 insertions(+), 46 deletions(-) diff --git a/_config.yml b/_config.yml index be52324..6a6e776 100644 --- a/_config.yml +++ b/_config.yml @@ -54,8 +54,8 @@ asciidoctor: template_dir: _templates attributes: xrefstyle: full - imagesdir: '{site-baseurl}/assets/images' - iconsdir: '{imagesdir}/../icons' + imagesdir: '{site-baseurl}/../assets/images' + iconsdir: '{site-baseurl}/assets/icons' relfileprefix: '{site-baseurl}' hardbreaks: true icons: '' diff --git a/_sass/search.scss b/_sass/search.scss index a307624..3f95e93 100644 --- a/_sass/search.scss +++ b/_sass/search.scss @@ -93,6 +93,8 @@ margin-bottom: $sp-1; list-style: none; @include fs-3; + height: 60vh; + overflow: auto; } .search-results-list-item { @@ -100,12 +102,16 @@ margin: 0; } +.search-results-category { + font-size: xx-small; +} + .search-results-link { display: block; - padding-top: $sp-1; + padding-top: 0; padding-right: $sp-3; - padding-bottom: $sp-1; - padding-left: $sp-3; + padding-bottom: $sp-3; + padding-left: 0; &:hover { color: var(--body-heading-color); diff --git a/assets/js/just-the-docs.js b/assets/js/just-the-docs.js index f5df696..a00dfb3 100644 --- a/assets/js/just-the-docs.js +++ b/assets/js/just-the-docs.js @@ -1,10 +1,10 @@ // Event handling function addEvent(el, type, handler) { - if (el.attachEvent) el.attachEvent('on' + type, handler); else el.addEventListener(type, handler); + if (el && el.attachEvent) el.attachEvent('on' + type, handler); else el.addEventListener(type, handler); } function removeEvent(el, type, handler) { - if (el.detachEvent) el.detachEvent('on' + type, handler); else el.removeEventListener(type, handler); + if (el && el.detachEvent) el.detachEvent('on' + type, handler); else el.removeEventListener(type, handler); } // Decode HTML @@ -42,47 +42,38 @@ function toggleNav() { // Site search function initSearch() { - var index = lunr(function () { - this.ref('id'); - this.field('title', { boost: 20 }); - this.field('content', { boost: 10 }); - this.field('tags', { boost: 5}); - this.field('url'); - }); - + let index; // Get the generated search_data.json file so lunr.js can search it locally. - sc = document.getElementsByTagName("script"); - source = ''; + let sc = document.getElementsByTagName("script"); + let source = ''; - for (idx = 0; idx < sc.length; idx++) { + let s; + for (let idx = 0; idx < sc.length; idx++) { s = sc.item(idx); - if (s.src && s.src.match(/just-the-docs\.js$/)) { source = s.src; } + if (s.src && s.src.match(/just-the-docs\.js$/)) { + source = s.src; + } } - jsPath = source.replace('just-the-docs.js', ''); + let jsPath = source.replace('just-the-docs.js', ''); - jsonPath = jsPath + 'search-data.json'; + let jsonPath = jsPath + 'search-data.json'; - var request = new XMLHttpRequest(); + const request = new XMLHttpRequest(); request.open('GET', jsonPath, true); request.onload = function () { if (request.status >= 200 && request.status < 400) { // Success! - var data = JSON.parse(request.responseText); - var keys = Object.keys(data); + const data = JSON.parse(request.responseText); + const keys = Object.keys(data); + + console.log('data', data) + + index = buildIndex(data) - for (var i in data) { - index.add({ - id: data[i].id, - title: data[i].title, - content: data[i].content, - url: data[i].url, - tags: data[i].tags - }); - } searchResults(data); } else { // We reached our target server, but it returned an error @@ -90,14 +81,41 @@ function initSearch() { } }; - request.onerror = function () { + request.onerror = function (e) { // There was a connection error of some sort - console.log('There was a connection error'); + console.log('There was a connection error', e); }; request.send(); + function buildIndex(data) { + console.log('buildIndex', data) + + return lunr(function(){ + this.ref('id'); + this.field('title', { boost: 20 }); + this.field('content', { boost: 10 }); + // this.metadataWhitelist = ['position'] + this.field('tags', {boost: 5}); + this.field('url'); + + for (const i in data) { + console.log(data[i]) + console.log(data[i].title) + + this.add({ + id: i, + title: data[i].title, + content: data[i].content, + url: data[i].url, + tags: data[i].tags + }); + } + }); + } + function searchResults(dataStore) { + console.log('searchResults init') var searchInput = document.querySelector('.js-search-input'); var searchResults = document.querySelector('.js-search-results'); @@ -118,6 +136,8 @@ function initSearch() { } const query = this.value; + console.log('query', query) + console.log(this) searchResults.innerHTML = ''; searchResults.classList.remove('active'); @@ -125,7 +145,8 @@ function initSearch() { if (query === '') { hideResults(); } else { - const results = index.search(query); + const results = index.search(`${query}~1`); + console.log('search results', results) if (results.length > 0) { searchResults.classList.add('active'); @@ -139,15 +160,20 @@ function initSearch() { for (const i in results) { let result = store[results[i].ref] - var resultsListItem = document.createElement('li'); - var resultsLink = document.createElement('a'); - var resultsUrlDesc = document.createElement('span'); + const resultsListItem = document.createElement('li'); + const resultWrapper = document.createElement('div') + const resultCategory = document.createElement('div') + const resultLinkWrapper = document.createElement('div') + const resultsLink = document.createElement('a'); + const resultsUrlDesc = document.createElement('span'); + + const resultsUrl = result.url; + const resultsRelUrl = result.relUrl; + resultCategory.innerText = `${htmlDecode(result.doc)}` + const resultsTitle = htmlDecode(result.title).replace(/^\d+\./, '') + const resultsType = result.collection; + const resultsTags = result.tags - var resultsUrl = result.url; - var resultsRelUrl = result.relUrl; - var resultsTitle = htmlDecode(result.title); - var resultsType = result.collection; - var resultsTags = result.tags resultsLink.setAttribute('href', resultsUrl); resultsLink.innerText = resultsTitle; @@ -156,11 +182,15 @@ function initSearch() { docsResultsList.classList.add('search-results-list'); resultsListItem.classList.add('search-results-list-item'); + resultCategory.classList.add('search-results-category'); resultsLink.classList.add('search-results-link'); resultsUrlDesc.classList.add('fs-2', 'text-grey-dk-000', 'd-block'); resultsLink.appendChild(resultsUrlDesc); - resultsListItem.appendChild(resultsLink); + resultsListItem.appendChild(resultWrapper) + resultWrapper.appendChild(resultCategory); + resultWrapper.appendChild(resultLinkWrapper); + resultLinkWrapper.appendChild(resultsLink) if (resultsType === 'faqs') { faqResultsList.appendChild(resultsListItem); diff --git a/assets/js/search-data.json b/assets/js/search-data.json index c6f01e6..9ca67e6 100644 --- a/assets/js/search-data.json +++ b/assets/js/search-data.json @@ -10,7 +10,8 @@ "url": "{{ page.url | absolute_url }}", "relUrl": "{{ page.url }}", "collection": "{{ page.collection }}", - "tags": "{{ page.tags | join: ', ' }}" + "tags": "{{ page.tags | join: ', ' }}", + "prdel": "{{ page.tags | join: ', ' }}" } {% unless forloop.last %}, {% endunless %}