Merge pull request google#275 from tekezo/fix/offline-search-html-ent…

…ities

Fix a offline search issue that escaped HTML entities is shown

assets/js/offline-search.js

@@ -98,7 +98,10 @@
                         });
                     });
                 })
-                .slice(0, 10);
+                .slice(
+                    0,
+                    $targetSearchInput.data('offlnie-search-max-results')
+                );
 
             //
             // Make result html

assets/json/offline-search-index.json

@@ -1,5 +1,6 @@
 {{- $.Scratch.Add "offline-search-index" slice -}}
 {{- range where .Site.AllPages ".Params.exclude_search" "!=" true -}}
-{{- $.Scratch.Add "offline-search-index" (dict "title" .Title "ref" .RelPermalink "body" .Plain "excerpt" (.Summary | truncate 100)) -}}
+{{/* We have to apply `htmlUnescape` again after `truncate` because `truncate` applies `html.EscapeString` if the argument is not HTML. */}}
+{{- $.Scratch.Add "offline-search-index" (dict "title" .Title "ref" .RelPermalink "body" (.Plain | htmlUnescape) "excerpt" (.Plain | htmlUnescape | truncate (.Site.Params.offlineSearchSummaryLength | default 70) | htmlUnescape)) -}}
 {{- end -}}
 {{- $.Scratch.Get "offline-search-index" | jsonify -}}

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 }}

userguide/config.toml

@@ -127,6 +127,8 @@ algolia_docsearch = false
 
 #Enable offline search with Lunr.js
 offlineSearch = false
+offlineSearchSummaryLength = 70
+offlineSearchMaxResults = 10
 
 # User interface configuration
 [params.ui]
@@ -188,5 +190,3 @@ enable = false
 	# url = "https://example.org/mail"
 	# icon = "fa fa-envelope"
         # desc = "Discuss development issues around the project"
-
-

userguide/content/en/docs/Adding content/navigation.md

@@ -187,6 +187,26 @@ Once you've completed these steps, local search is enabled for your site and res
 If you're [testing this locally](/docs/deployment/#serving-your-site-locally) using Hugo’s local server functionality, you need to build your `offline-search-index.xxx.json` file first by running `hugo`. If you have the Hugo server running while you build `offline-search-index.xxx.json`, you may need to stop the server and restart it in order to see your search results.
 {{% /alert %}}
 
+### Changing the summary length of the local search results
+
+You can customize the summary length by setting `offlineSearchSummaryLength` in `config.toml`.
+
+```
+#Enable offline search with Lunr.js
+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.