diff --git a/docs/searching.md b/docs/searching.md index 1b8b6843..870618d1 100644 --- a/docs/searching.md +++ b/docs/searching.md @@ -50,13 +50,13 @@ In the above example, pressing 2 will launch Bookstack. Or hitting ⏎. Web search options are configured under `appConfig.webSearch`. -#### Setting Search Engine +### Setting Search Engine Set your default search engine using the `webSearch.searchEngine` property. This defaults to DuckDuckGo. Search engine must be referenced by their key, the following providers are supported: - [`duckduckgo`](https://duckduckgo.com), [`google`](https://google.com), [`whoogle`](https://whoogle.sdf.org), [`qwant`](https://www.qwant.com), [`startpage`](https://www.startpage.com), [`searx-bar`](https://searx.bar), [`searx-info`](https://searx.info) - [`searx-tiekoetter`](https://searx.tiekoetter.com), [`searx-bissisoft`](https://searx.bissisoft.com), [`ecosia`](https://www.ecosia.org), [`metager`](https://metager.org/meta), [`swisscows`](https://swisscows.com), [`mojeek`](https://www.mojeek.com) - [`wikipedia`](https://en.wikipedia.org), [`wolframalpha`](https://www.wolframalpha.com), [`stackoverflow`](https://stackoverflow.com), [`github`](https://github.com), [`reddit`](https://www.reddit.com), [`youtube`](https://youtube.com), [`bbc`](https://www.bbc.co.uk) -#### Using Custom Search Engine +### Using Custom Search Engine You can also use a custom search engine, that isn't included in the above list (like a self-hosted instance of [Whoogle](https://github.com/benbusby/whoogle-search) or [Searx](https://searx.github.io/searx/)). Set `searchEngine: custom`, and then specify the URL (plus query params) to you're search engine under `customSearchEngine`. For example: @@ -67,10 +67,34 @@ appConfig: customSearchEngine: 'https://searx.local/search?q=' ``` -#### Setting Opening Method +### Setting Opening Method In a similar way to opening apps, you can specify where you would like search results to be opened. This is done under the `openingMethod` attribute, and can be set to either `newtab`, `sametab` or `workspace`. By default results are opened in a new tab. -#### Disabling Web Search +### Using Bangs +An insanely useful feature of DDG is [Bangs](https://duckduckgo.com/bang), where you type a specific character combination at the start of your search query, and it will be redirected the that website, such as '!w Docker' will display the Docker wikipedia page. Dashy has a similar feature, enabling you to define your own custom bangs to redirect search results to a specific app, website or search engine. + +This is done under the `searchBangs` property, with a list of key value pairs. The key is what you will type, and the value is the destination, either as an identifier or a URL with query parameters. + +For example: + +```yaml +appConfig: + webSearch: + searchEngine: 'duckduckgo' + openingMethod: 'newtab' + searchBangs: + /r: reddit + /w: wikipedia + /s: https://whoogle.local/search?q= + /a: https://www.amazon.co.uk/s?k= + ':wolf': wolframalpha + ':so': stackoverflow + ':git': github +``` + +Note that bangs begging with `!` or `:` must be surrounded them in quotes + +### Disabling Web Search Web search can be disabled, by setting `disableWebSearch`, for example: ```yaml