Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/chipzoller/hugo-clarity.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorweru <fromweru@gmail.com>2022-05-15 00:17:32 +0300
committerweru <fromweru@gmail.com>2022-05-15 00:17:32 +0300
commit4c78fa19c26dca216ddacdbbb754e0d997898dce (patch)
treea1f2b36b946405117d3c61f28b753111f3d624e5
parent906ee658ed2c0ea92e6a23e5e6c5656d3e06fb42 (diff)
update docs
Signed-off-by: weru <fromweru@gmail.com>
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index d02d173..6638552 100644
--- a/README.md
+++ b/README.md
@@ -864,3 +864,14 @@ enableSearch = true
Live search works even for multilingual sites.
For Chinese-like languages, it may or may not work.
+
+__Search Scope__
+
+- Searching within a section will yield results from that section.
+
+ For example, if you have 2 `mainSections` 1/ vegetables 2/ fruits, searching in the fruits section will only produce results for that section.
+- Searching outside a section will search the entire site.
+
+ For example, with the above `mainSections` setup, searching from the homepage will produce results from both sections and other pages of the site.
+
+ Future implementations may include a github-like feature i.e `search all site`. This PR will leave that to a future PR