From 00e4a7886e830b26838b5a33793d5e75086e4ce8 Mon Sep 17 00:00:00 2001
From: James Elliott <james-d-elliott@users.noreply.github.com>
Date: Sat, 25 Jun 2022 11:07:03 +1000
Subject: [PATCH 1/5] feat(search): allow complete section customization

This allows configuring the searchable sections and which sections show the search box. In addition the javascript is only included on pages where the search box is visible.
---
 assets/js/index.js                         | 8 +++++++-
 config/_default/params.toml                | 2 ++
 layouts/partials/footer/script-footer.html | 8 +++++---
 layouts/partials/header/header.html        | 2 +-
 4 files changed, 15 insertions(+), 5 deletions(-)

diff --git a/assets/js/index.js b/assets/js/index.js
index f3d8da1..dbaaa28 100644
--- a/assets/js/index.js
+++ b/assets/js/index.js
@@ -94,7 +94,13 @@ Source:
 
   // https://discourse.gohugo.io/t/range-length-or-last-element/3803/2
 
-  {{ $list := (where .Site.Pages "Section" "docs") -}}
+  {{ $list := slice }}
+  {{- if eq (len .Site.Params.options.searchSectionsIndex) 0 }}
+  {{- $list = (where .Site.Pages "Section" "docs") }}
+  {{- else }}
+  {{- $list = (where .Site.Pages "Type" "in" .Site.Params.options.searchSectionsIndex) }}
+  {{- end }}
+
   {{ $len := (len $list) -}}
 
   {{ range $index, $element := $list -}}
diff --git a/config/_default/params.toml b/config/_default/params.toml
index 5780d96..df9903b 100644
--- a/config/_default/params.toml
+++ b/config/_default/params.toml
@@ -83,6 +83,8 @@ lastMod = false
   clipBoard = true
   instantPage = true
   flexSearch = true
+  searchSectionsShow = []
+  searchSectionsIndex = []
   darkMode = true
   bootStrapJs = true
   breadCrumb = false
diff --git a/layouts/partials/footer/script-footer.html b/layouts/partials/footer/script-footer.html
index f57261a..8cfe03e 100644
--- a/layouts/partials/footer/script-footer.html
+++ b/layouts/partials/footer/script-footer.html
@@ -39,6 +39,8 @@
   {{ $slice = $slice | append $flexSearch -}}
 {{ end -}}
 
+{{ $includeFlexSearch := and .Site.Params.options.flexSearch (or (eq (len .Site.Params.options.searchSectionsShow) 0) (in .Site.Params.options.searchSectionsShow .Section)) }}
+
 {{ if .Site.Params.options.darkMode -}}
   {{ $darkMode := resources.Get "js/darkmode.js" -}}
   {{ $darkMode := $darkMode | js.Build -}}
@@ -77,7 +79,7 @@
   {{ with .Params.mermaid -}}
     <script src="{{ $mermaid.RelPermalink }}" defer></script>
   {{ end -}}
-  {{ if .Site.Params.options.flexSearch -}}
+  {{ if $includeFlexSearch -}}
     <script src="{{ $index.RelPermalink }}" defer></script>
   {{ end -}}
 {{ else -}}
@@ -102,7 +104,7 @@
   {{ with .Params.mermaid -}}
     <script src="{{ $mermaid.RelPermalink }}" integrity="{{ $mermaid.Data.Integrity }}" crossorigin="anonymous" defer></script>
   {{ end -}}
-  {{ if .Site.Params.options.flexSearch -}}
+  {{ if $includeFlexSearch -}}
     <script src="{{ $index.Permalink }}" integrity="{{ $index.Data.Integrity }}" crossorigin="anonymous" defer></script>
   {{ end -}}
-{{ end -}}
\ No newline at end of file
+{{ end -}}
diff --git a/layouts/partials/header/header.html b/layouts/partials/header/header.html
index 65744ec..5dfae5b 100644
--- a/layouts/partials/header/header.html
+++ b/layouts/partials/header/header.html
@@ -77,7 +77,7 @@
           {{ end -}}
         </ul>
 
-        {{ if .Site.Params.options.flexSearch -}}
+        {{ if and .Site.Params.options.flexSearch (or (eq (len .Site.Params.options.searchSectionsShow) 0) (in .Site.Params.options.searchSectionsShow .Section)) -}}
         <hr class="text-black-50 my-4 d-lg-none">
         <form class="doks-search position-relative flex-grow-1 ms-lg-auto me-lg-2">
           <input id="search" class="form-control is-search" type="search" placeholder="Search docs..." aria-label="Search docs..." autocomplete="off">

From fa01f4ab56541a5acc954f04cc48c67ffa2772ee Mon Sep 17 00:00:00 2001
From: James Elliott <james-d-elliott@users.noreply.github.com>
Date: Sat, 25 Jun 2022 12:20:57 +1000
Subject: [PATCH 2/5] fix: avoid error if unset

---
 assets/js/index.js                         |  2 +-
 layouts/partials/footer/script-footer.html | 13 ++++++++-----
 layouts/partials/header/header.html        |  9 ++++++++-
 3 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/assets/js/index.js b/assets/js/index.js
index dbaaa28..2f47890 100644
--- a/assets/js/index.js
+++ b/assets/js/index.js
@@ -95,7 +95,7 @@ Source:
   // https://discourse.gohugo.io/t/range-length-or-last-element/3803/2
 
   {{ $list := slice }}
-  {{- if eq (len .Site.Params.options.searchSectionsIndex) 0 }}
+  {{- if or (not (isset .Site.Params.options "searchsectionsindex")) (eq (len .Site.Params.options.searchSectionsIndex) 0) }}
   {{- $list = (where .Site.Pages "Section" "docs") }}
   {{- else }}
   {{- $list = (where .Site.Pages "Type" "in" .Site.Params.options.searchSectionsIndex) }}
diff --git a/layouts/partials/footer/script-footer.html b/layouts/partials/footer/script-footer.html
index 8cfe03e..769494a 100644
--- a/layouts/partials/footer/script-footer.html
+++ b/layouts/partials/footer/script-footer.html
@@ -34,13 +34,16 @@
   {{ $slice = $slice | append $instantPage -}}
 {{ end -}}
 
-{{ if .Site.Params.options.flexSearch -}}
+{{ $showFlexSearch := .Site.Params.options.flexSearch }}
+
+{{ if $showFlexSearch -}}
   {{ $flexSearch := resources.Get "js/vendor/flexsearch/dist/flexsearch.bundle.js" -}}
   {{ $slice = $slice | append $flexSearch -}}
+  {{ if (isset .Site.Params.options "searchsectionsshow") -}}
+  {{ $showFlexSearch = or (eq (len .Site.Params.options.searchSectionsShow) 0) (in .Site.Params.options.searchSectionsShow .Section) -}}
+  {{ end -}}
 {{ end -}}
 
-{{ $includeFlexSearch := and .Site.Params.options.flexSearch (or (eq (len .Site.Params.options.searchSectionsShow) 0) (in .Site.Params.options.searchSectionsShow .Section)) }}
-
 {{ if .Site.Params.options.darkMode -}}
   {{ $darkMode := resources.Get "js/darkmode.js" -}}
   {{ $darkMode := $darkMode | js.Build -}}
@@ -79,7 +82,7 @@
   {{ with .Params.mermaid -}}
     <script src="{{ $mermaid.RelPermalink }}" defer></script>
   {{ end -}}
-  {{ if $includeFlexSearch -}}
+  {{ if $showFlexSearch -}}
     <script src="{{ $index.RelPermalink }}" defer></script>
   {{ end -}}
 {{ else -}}
@@ -104,7 +107,7 @@
   {{ with .Params.mermaid -}}
     <script src="{{ $mermaid.RelPermalink }}" integrity="{{ $mermaid.Data.Integrity }}" crossorigin="anonymous" defer></script>
   {{ end -}}
-  {{ if $includeFlexSearch -}}
+  {{ if $showFlexSearch -}}
     <script src="{{ $index.Permalink }}" integrity="{{ $index.Data.Integrity }}" crossorigin="anonymous" defer></script>
   {{ end -}}
 {{ end -}}
diff --git a/layouts/partials/header/header.html b/layouts/partials/header/header.html
index 5dfae5b..8b4e4ca 100644
--- a/layouts/partials/header/header.html
+++ b/layouts/partials/header/header.html
@@ -77,7 +77,14 @@
           {{ end -}}
         </ul>
 
-        {{ if and .Site.Params.options.flexSearch (or (eq (len .Site.Params.options.searchSectionsShow) 0) (in .Site.Params.options.searchSectionsShow .Section)) -}}
+        {{- $showFlexSearch := .Site.Params.options.flexSearch }}
+        {{- if $showFlexSearch }}
+        {{- if (isset .Site.Params.options "searchsectionsshow") }}
+        {{- $showFlexSearch = or (eq (len .Site.Params.options.searchSectionsShow) 0) (in .Site.Params.options.searchSectionsShow .Section) }}
+        {{- end }}
+        {{- end }}
+
+        {{ if $showFlexSearch -}}
         <hr class="text-black-50 my-4 d-lg-none">
         <form class="doks-search position-relative flex-grow-1 ms-lg-auto me-lg-2">
           <input id="search" class="form-control is-search" type="search" placeholder="Search docs..." aria-label="Search docs..." autocomplete="off">

From b532c69bd769353490e412e22d790e484aeb91dc Mon Sep 17 00:00:00 2001
From: James Elliott <james-d-elliott@users.noreply.github.com>
Date: Sat, 25 Jun 2022 13:36:32 +1000
Subject: [PATCH 3/5] feat: add all method

---
 assets/js/index.js                         | 8 ++++++--
 layouts/partials/footer/script-footer.html | 2 +-
 layouts/partials/header/header.html        | 2 +-
 3 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/assets/js/index.js b/assets/js/index.js
index 2f47890..0c2de5d 100644
--- a/assets/js/index.js
+++ b/assets/js/index.js
@@ -95,11 +95,15 @@ Source:
   // https://discourse.gohugo.io/t/range-length-or-last-element/3803/2
 
   {{ $list := slice }}
-  {{- if or (not (isset .Site.Params.options "searchsectionsindex")) (eq (len .Site.Params.options.searchSectionsIndex) 0) }}
-  {{- $list = (where .Site.Pages "Section" "docs") }}
+  {{- if and (isset .Site.Params.options "searchsectionsindex") (not (eq (len .Site.Params.options.searchSectionsIndex) 0)) }}
+  {{- if eq .Site.Params.options.searchSectionsIndex "ALL" }}
+  {{- $list = .Site.Pages }}
   {{- else }}
   {{- $list = (where .Site.Pages "Type" "in" .Site.Params.options.searchSectionsIndex) }}
   {{- end }}
+  {{- else }}
+  {{- $list = (where .Site.Pages "Section" "docs") }}
+  {{- end }}
 
   {{ $len := (len $list) -}}
 
diff --git a/layouts/partials/footer/script-footer.html b/layouts/partials/footer/script-footer.html
index 769494a..1a571d1 100644
--- a/layouts/partials/footer/script-footer.html
+++ b/layouts/partials/footer/script-footer.html
@@ -39,7 +39,7 @@
 {{ if $showFlexSearch -}}
   {{ $flexSearch := resources.Get "js/vendor/flexsearch/dist/flexsearch.bundle.js" -}}
   {{ $slice = $slice | append $flexSearch -}}
-  {{ if (isset .Site.Params.options "searchsectionsshow") -}}
+  {{ if and (isset .Site.Params.options "searchsectionsshow") (not (eq .Site.Params.options.searchSectionsShow "ALL")) -}}
   {{ $showFlexSearch = or (eq (len .Site.Params.options.searchSectionsShow) 0) (in .Site.Params.options.searchSectionsShow .Section) -}}
   {{ end -}}
 {{ end -}}
diff --git a/layouts/partials/header/header.html b/layouts/partials/header/header.html
index 8b4e4ca..77c24de 100644
--- a/layouts/partials/header/header.html
+++ b/layouts/partials/header/header.html
@@ -79,7 +79,7 @@
 
         {{- $showFlexSearch := .Site.Params.options.flexSearch }}
         {{- if $showFlexSearch }}
-        {{- if (isset .Site.Params.options "searchsectionsshow") }}
+        {{- if and (isset .Site.Params.options "searchsectionsshow") (not (eq .Site.Params.options.searchSectionsShow "ALL")) }}
         {{- $showFlexSearch = or (eq (len .Site.Params.options.searchSectionsShow) 0) (in .Site.Params.options.searchSectionsShow .Section) }}
         {{- end }}
         {{- end }}

From 76d7db7b4c3514cebfd1631a2fdb29234b400221 Mon Sep 17 00:00:00 2001
From: James Elliott <james-d-elliott@users.noreply.github.com>
Date: Sat, 25 Jun 2022 21:54:54 +1000
Subject: [PATCH 4/5] feat: handle homepage for search sections show

---
 layouts/partials/footer/script-footer.html | 2 +-
 layouts/partials/header/header.html        | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/layouts/partials/footer/script-footer.html b/layouts/partials/footer/script-footer.html
index 1a571d1..7240b00 100644
--- a/layouts/partials/footer/script-footer.html
+++ b/layouts/partials/footer/script-footer.html
@@ -40,7 +40,7 @@
   {{ $flexSearch := resources.Get "js/vendor/flexsearch/dist/flexsearch.bundle.js" -}}
   {{ $slice = $slice | append $flexSearch -}}
   {{ if and (isset .Site.Params.options "searchsectionsshow") (not (eq .Site.Params.options.searchSectionsShow "ALL")) -}}
-  {{ $showFlexSearch = or (eq (len .Site.Params.options.searchSectionsShow) 0) (in .Site.Params.options.searchSectionsShow .Section) -}}
+  {{ $showFlexSearch = or (eq (len .Site.Params.options.searchSectionsShow) 0) (in .Site.Params.options.searchSectionsShow .Section) (and .IsHome (in .Site.Params.options.searchSectionsShow "HomePage")) -}}
   {{ end -}}
 {{ end -}}
 
diff --git a/layouts/partials/header/header.html b/layouts/partials/header/header.html
index 77c24de..d6e0f6e 100644
--- a/layouts/partials/header/header.html
+++ b/layouts/partials/header/header.html
@@ -80,7 +80,7 @@
         {{- $showFlexSearch := .Site.Params.options.flexSearch }}
         {{- if $showFlexSearch }}
         {{- if and (isset .Site.Params.options "searchsectionsshow") (not (eq .Site.Params.options.searchSectionsShow "ALL")) }}
-        {{- $showFlexSearch = or (eq (len .Site.Params.options.searchSectionsShow) 0) (in .Site.Params.options.searchSectionsShow .Section) }}
+        {{- $showFlexSearch = or (eq (len .Site.Params.options.searchSectionsShow) 0) (in .Site.Params.options.searchSectionsShow .Section) (and .IsHome (in .Site.Params.options.searchSectionsShow "HomePage")) }}
         {{- end }}
         {{- end }}
 

From 8588fe5b16838d9c848102b4b16d59cf12ec5359 Mon Sep 17 00:00:00 2001
From: James Elliott <james-d-elliott@users.noreply.github.com>
Date: Sat, 25 Jun 2022 21:59:06 +1000
Subject: [PATCH 5/5] feat: handle homepage for search sections index

---
 assets/js/index.js | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/assets/js/index.js b/assets/js/index.js
index 0c2de5d..15e09bb 100644
--- a/assets/js/index.js
+++ b/assets/js/index.js
@@ -100,6 +100,9 @@ Source:
   {{- $list = .Site.Pages }}
   {{- else }}
   {{- $list = (where .Site.Pages "Type" "in" .Site.Params.options.searchSectionsIndex) }}
+  {{- if (in .Site.Params.options.searchSectionsIndex "HomePage") }}
+  {{ $list = $list | append .Site.Home }}
+  {{- end }}
   {{- end }}
   {{- else }}
   {{- $list = (where .Site.Pages "Section" "docs") }}