Add offlineSearchMaxResults to config.toml

sriramkandukuri · May 23, 2020 · 4e0c7e8 · 4e0c7e8
1 parent 3c17f0f
commit 4e0c7e8
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 1 deletion.
diff --git a/assets/js/offline-search.js b/assets/js/offline-search.js
@@ -98,7 +98,7 @@
                         });
                     });
                 })
-                .slice(0, 10);
+                .slice(0, $targetSearchInput.data('offlnie-search-max-results'));
 
             //
             // Make result html

diff --git a/layouts/partials/search-input.html b/layouts/partials/search-input.html
@@ -18,5 +18,6 @@
   */}}
   data-offline-search-index-json-src="{{ $offlineSearchIndexFingerprint.RelPermalink }}"
   data-offline-search-base-href="/"
+  data-offlnie-search-max-results="{{ .Site.Params.offlineSearchMaxResults | default 10 }}"
 >
 {{ end }}
diff --git a/userguide/config.toml b/userguide/config.toml
@@ -128,6 +128,7 @@ algolia_docsearch = false
 #Enable offline search with Lunr.js
 offlineSearch = false
 offlineSearchSummaryLength = 70
+offlineSearchMaxResults = 10
 
 # User interface configuration
 [params.ui]

diff --git a/userguide/content/en/docs/Adding content/navigation.md b/userguide/content/en/docs/Adding content/navigation.md
@@ -197,6 +197,16 @@ offlineSearch = true
 offlineSearchSummaryLength = 200
 ```
 
+### Changing the maximum result count of the local search
+
+You can customize the maximum result count by setting `offlineSearchMaxResults` in `config.toml`.
+
+```
+#Enable offline search with Lunr.js
+offlineSearch = true
+offlineSearchMaxResults = 25
+```
+
 ### Changing the width of the local search results popover
 
 The width of the search results popover will automatically widen according to the content.