summaryrefslogtreecommitdiff
path: root/plugins/frontend-search/README.md
diff options
context:
space:
mode:
authorJosh Hubbard <jhubbardsf@gmail.com>2023-12-06 09:15:53 +0100
committerCarlo Sala <carlosalag@protonmail.com>2023-12-06 09:16:43 +0100
commit346bd1cd53e1bd3bd881f94552efadeebab430e4 (patch)
treed7d1abcf00371bc9bcdc1e767d6b38d5c119ddc3 /plugins/frontend-search/README.md
parentc37df3ebd48df98b0987d891acc7ea30044bb113 (diff)
downloadzsh-346bd1cd53e1bd3bd881f94552efadeebab430e4.tar.gz
zsh-346bd1cd53e1bd3bd881f94552efadeebab430e4.tar.bz2
zsh-346bd1cd53e1bd3bd881f94552efadeebab430e4.zip
feat(frontend-search): add `I am lucky` option
Diffstat (limited to 'plugins/frontend-search/README.md')
-rw-r--r--plugins/frontend-search/README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/plugins/frontend-search/README.md b/plugins/frontend-search/README.md
index 619d31e7f..920795060 100644
--- a/plugins/frontend-search/README.md
+++ b/plugins/frontend-search/README.md
@@ -66,7 +66,16 @@ If you want to have another context, open an Issue and tell us!
## Fallback search behaviour
-The plugin will use Google as a fallback if the docs site for a search context does not have a search function. You can set the fallback search engine to DuckDuckGo by setting `FRONTEND_SEARCH_FALLBACK='duckduckgo'` in your `~/.zshrc` file before Oh My Zsh is sourced.
+The plugin will use Google as a fallback if the docs site for a search context does not have a search
+function. You can set the fallback search engine to DuckDuckGo by setting
+`FRONTEND_SEARCH_FALLBACK='duckduckgo'` in your `~/.zshrc` file before Oh My Zsh is sourced.
+
+## DuckDuckGo Lucky Search
+
+Enable DuckDuckGo's "ducky" (lucky) search feature to automatically access the top search result. This feature
+is optimized for DuckDuckGo, as Google redirects to an intermediate page. The FRONTEND_SEARCH_FALLBACK_LUCKY
+environment variable triggers the use of DuckDuckGo's lucky search, rendering the FRONTEND_SEARCH_FALLBACK
+setting unnecessary in this context.
## Author