From 78faffab6d549258ce4057d689fb8386ac1d3045 Mon Sep 17 00:00:00 2001 From: Nick Hammond Date: Wed, 24 Jul 2024 08:22:41 -0600 Subject: [PATCH 1/9] Connect search form and get lunr search working --- _includes/nav.html | 4 +-- _layouts/docs.html | 4 +-- _sass/modules/_search.scss | 17 ++++++++++ assets/js/search/lunr.min.js | 6 ++++ assets/js/search/script.js | 64 ++++++++++++++++++++++++++++++++++++ docs/search/index.md | 27 +++++++++++++++ 6 files changed, 118 insertions(+), 4 deletions(-) create mode 100644 assets/js/search/lunr.min.js create mode 100644 assets/js/search/script.js create mode 100644 docs/search/index.md diff --git a/_includes/nav.html b/_includes/nav.html index 9107c9c..712f374 100755 --- a/_includes/nav.html +++ b/_includes/nav.html @@ -7,8 +7,8 @@
-
- + + diff --git a/_layouts/docs.html b/_layouts/docs.html index 19c371f..b6faadc 100644 --- a/_layouts/docs.html +++ b/_layouts/docs.html @@ -98,8 +98,8 @@
From 7d0194200abaaf89530be132dbc6ce9e85c44212 Mon Sep 17 00:00:00 2001 From: Sean Mitchell Date: Sun, 28 Jul 2024 16:12:40 -0700 Subject: [PATCH 4/9] Adjust link transition --- _sass/base/_elements.scss | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/_sass/base/_elements.scss b/_sass/base/_elements.scss index 5dbca3c..ac8bf7a 100755 --- a/_sass/base/_elements.scss +++ b/_sass/base/_elements.scss @@ -117,7 +117,10 @@ a { text-decoration: underline; text-decoration-thickness: 0.09em; text-underline-offset: 0.09em; - transition: color var(--transition); + transition: + color var(--transition), + text-decoration-color var(--transition) + ; } em, From f78b5a275e0fc18b1c1d32d504b5a3f435daca38 Mon Sep 17 00:00:00 2001 From: Sean Mitchell Date: Sun, 28 Jul 2024 16:18:27 -0700 Subject: [PATCH 5/9] Move search JS --- assets/js/{search => }/lunr.min.js | 0 assets/js/modules/search.js | 89 ++++++++++++++++++++++++++++++ assets/js/script.js | 3 + assets/js/search/script.js | 64 --------------------- 4 files changed, 92 insertions(+), 64 deletions(-) rename assets/js/{search => }/lunr.min.js (100%) create mode 100644 assets/js/modules/search.js delete mode 100644 assets/js/search/script.js diff --git a/assets/js/search/lunr.min.js b/assets/js/lunr.min.js similarity index 100% rename from assets/js/search/lunr.min.js rename to assets/js/lunr.min.js diff --git a/assets/js/modules/search.js b/assets/js/modules/search.js new file mode 100644 index 0000000..d6b4fd1 --- /dev/null +++ b/assets/js/modules/search.js @@ -0,0 +1,89 @@ +function ready() { + + function showResults(results, store, searchTerm) { + + var searchResults = document.getElementById('search-results'); + + document.getElementById('search-query').innerHTML = 'Search results for ' + searchTerm + ''; + + var appendString = ''; + + if(results.length) { + + for(var i = 0; i < results.length; i++) { + + var item = store[results[i].ref]; + + appendString += '
'; + appendString += '

' + item.title + '

'; + appendString += ' ' + item.section + ''; + appendString += '

' + item.content.substring(0, 250) + '…

'; + appendString += '
'; + + } + + } else { + + appendString = '

No results found.

'; + + } + + searchResults.innerHTML = appendString; + + } + + function getQuery(variable) { + + var query = window.location.search.substring(1); + var vars = query.split('&'); + + for(var i = 0; i < vars.length; i++) { + + var pair = vars[i].split('='); + + if(pair[0] === variable) { + + return decodeURIComponent(pair[1].replace(/\+/g, '%20')); + + } + + } + + } + + var searchTerm = getQuery('q'); + + if(searchTerm) { + + document.getElementById('search-box').setAttribute('value', searchTerm); + + var idx = lunr(function() { + + this.field('id'); + this.field('title', { + boost: 10 + }); + this.field('author'); + this.field('section'); + this.field('content'); + + for(var key in window.store) { + this.add({ + 'id': key, + 'title': window.store[key].title, + 'author': window.store[key].author, + 'section': window.store[key].section, + 'content': window.store[key].content + }); + } + }); + + var results = idx.search(searchTerm); + + showResults(results, window.store, searchTerm); + + } + +} + +export { ready }; diff --git a/assets/js/script.js b/assets/js/script.js index 1434f74..5090147 100644 --- a/assets/js/script.js +++ b/assets/js/script.js @@ -1,10 +1,13 @@ import * as code from './modules/code.js'; +import * as search from './modules/search.js'; import * as video from './modules/video.js'; document.addEventListener('DOMContentLoaded', () => { code.ready(); + search.ready(); + video.ready(); }); diff --git a/assets/js/search/script.js b/assets/js/search/script.js deleted file mode 100644 index 6ee0830..0000000 --- a/assets/js/search/script.js +++ /dev/null @@ -1,64 +0,0 @@ -(function() { - function showResults(results, store, searchTerm) { - var searchResults = document.getElementById('search-results'); - - if (results.length) { // If there are results... - document.getElementById('search-query').innerHTML = "Search results for " + searchTerm + ""; - - var appendString = ''; - - for (var i = 0; i < results.length; i++) { // Iterate over them and generate html - var item = store[results[i].ref]; - appendString += '

  • ' + item.title + '

    '; - appendString += '' + item.section + ''; - appendString += '

    ' + item.content.substring(0, 250) + '...

    • '; - } - - searchResults.innerHTML = appendString; - } else { - searchResults.innerHTML = '
  • No results found
    • '; - } - } - - function getQuery(variable) { - var query = window.location.search.substring(1); - var vars = query.split('&'); - - for (var i = 0; i < vars.length; i++) { - var pair = vars[i].split('='); - - if (pair[0] === variable) { - return decodeURIComponent(pair[1].replace(/\+/g, '%20')); - } - } - } - - var searchTerm = getQuery('q'); - - if (searchTerm) { - document.getElementById('search-box').setAttribute("value", searchTerm); - - // Initalize lunr.js with the fields to search. - // The title field is given more weight with the "boost" parameter - var idx = lunr(function () { - this.field('id'); - this.field('title', { boost: 10 }); - this.field('author'); - this.field('section'); - this.field('content'); - - for (var key in window.store) { // Add the JSON we generated from the site content to Lunr.js. - this.add({ - 'id': key, - 'title': window.store[key].title, - 'author': window.store[key].author, - 'section': window.store[key].section, - 'content': window.store[key].content - }); - } - }); - - var results = idx.search(searchTerm); // Perform search with Lunr.js - showResults(results, window.store, searchTerm); - } -})(); \ No newline at end of file From 66449a6ca18570025cb3802e203d99958db5f055 Mon Sep 17 00:00:00 2001 From: Sean Mitchell Date: Sun, 28 Jul 2024 16:18:51 -0700 Subject: [PATCH 6/9] Add Lunr script to head include --- _includes/head.html | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_includes/head.html b/_includes/head.html index f7c24fc..830064e 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -32,7 +32,9 @@ + + From 285410f54594207508f511b6cc62a45d48ab0bb2 Mon Sep 17 00:00:00 2001 From: Sean Mitchell Date: Sun, 28 Jul 2024 16:19:37 -0700 Subject: [PATCH 7/9] Adjust search query and results style --- _sass/modules/_search.scss | 81 +++++++++++++++++++++++++++++++++----- 1 file changed, 71 insertions(+), 10 deletions(-) diff --git a/_sass/modules/_search.scss b/_sass/modules/_search.scss index ead9690..146957f 100755 --- a/_sass/modules/_search.scss +++ b/_sass/modules/_search.scss @@ -92,19 +92,80 @@ } -ul#search-results { - list-style: none; - padding-left: 0; +#search-query { + + mark { + color: inherit; + font-style: italic; + font-weight: 400; + text-decoration: underline; + text-decoration-thickness: 0.055em; + text-underline-offset: 0.1em; + } + +} + +#search-results { + + display: flex; + flex-direction: column; + gap: 1.4em; + + .search-result { + + display: flex; + flex-direction: column; + + h3 { - li { - margin-top: 1.5em; + color: var(--color-blue); + + a { + color: inherit; + text-decoration: underline; + text-decoration-color: rgba(var(--rgb-blue), 0); + } - p { - margin-top: 0.2em; } - .section { - color: var(--color-grey-light); + small { + + color: var(--color-grey); + font-size: 80%; + font-weight: 500; + margin-bottom: 0.6em; + margin-top: 0.1em; + + a { + color: inherit; + text-decoration: none; + } + } + } -} \ No newline at end of file + + @media(hover: hover) { + + h3 a { + + &:focus, + &:hover { + color: var(--color-black); + text-decoration-color: var(--color-black); + } + + } + + small a { + + &:focus, + &:hover { + color: var(--color-black); + } + + } + + } + +} From b7f2cfd3b54a208e4e95333f6457bfce3eca0ed2 Mon Sep 17 00:00:00 2001 From: Sean Mitchell Date: Sun, 28 Jul 2024 16:24:34 -0700 Subject: [PATCH 8/9] Adjust docs search index --- docs/search/index.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/search/index.md b/docs/search/index.md index ff2fb07..548b752 100644 --- a/docs/search/index.md +++ b/docs/search/index.md @@ -1,11 +1,11 @@ --- -layout: docs title: Search Results +nav: false --- -

    +

    -
      +
      - - - \ No newline at end of file From 87fce7527d3c4d94bf8190d13bb8d2d3aba7b350 Mon Sep 17 00:00:00 2001 From: Sean Mitchell Date: Sun, 28 Jul 2024 16:25:10 -0700 Subject: [PATCH 9/9] Add titles to docs redirect indexes --- docs/commands/index.md | 1 + docs/configuration/index.md | 1 + docs/hooks/index.md | 1 + 3 files changed, 3 insertions(+) diff --git a/docs/commands/index.md b/docs/commands/index.md index 37c2543..c455d2d 100644 --- a/docs/commands/index.md +++ b/docs/commands/index.md @@ -1,4 +1,5 @@ --- +title: Commands redirect_to: - /docs/commands/view-all-commands/ --- diff --git a/docs/configuration/index.md b/docs/configuration/index.md index eb315d9..05407b1 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -1,4 +1,5 @@ --- +title: Configuration redirect_to: - /docs/configuration/configuration-overview/ --- diff --git a/docs/hooks/index.md b/docs/hooks/index.md index 9cd1fef..51becc7 100644 --- a/docs/hooks/index.md +++ b/docs/hooks/index.md @@ -1,4 +1,5 @@ --- +title: Hooks redirect_to: - /docs/hooks/hooks-overview/ ---