Skip to content

armgit / dashy

Public Imported from GitHub
0

πŸš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

πŸ“ Updates search and shortcut docs

Alicia Sykes12743645f633
diff --git a/docs/configuring.md b/docs/configuring.md
index 6acefec9..3231fa6e 100644
--- a/docs/configuring.md
+++ b/docs/configuring.md
@@ -221,7 +221,7 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)**
**Field** | **Type** | **Required**| **Description**
--- | --- | --- | ---
**`disableWebSearch`** | `boolean` | _Optional_ | Web search is enabled by default, but can be disabled by setting this property to `true`. Defaults to `false`
-**`searchEngine`** | `string` | _Optional_ | Set the key name for your search engine. Can also use a custom engine by setting this property to `custom`. Currently supported: `duckduckgo`, `google`, `whoogle`, `qwant`, `startpage`, `searx-bar` and `searx-info`. Defaults to `duckduckgo`
+**`searchEngine`** | `string` | _Optional_ | Set the key name for your search engine. Can also use a custom engine by setting this property to `custom`. See the [searching docs](./searching.md#setting-search-engine) for the full list of built-in keys. Defaults to `duckduckgo`
**`customSearchEngine`** | `string` | _Optional_ | You can also use a custom search engine, or your own self-hosted instance. This requires `searchEngine: custom` to be set. Then add the URL of your service, with GET query string included here
**`openingMethod`** | `string` | _Optional_ | Set your preferred opening method for search results: `newtab`, `sametab`, `workspace`. Defaults to `newtab`
**`searchBangs`** | `object` | _Optional_ | A key-value-pair set of custom search _bangs_ for redirecting query to a specific app or search engine. The key of each should be the bang you will type (typically starting with `/`, `!` or `:`), and value is the destination, either as a search engine key (e.g. `reddit`) or a URL with search parameters (e.g. `https://en.wikipedia.org/w/?search=`)
diff --git a/docs/searching.md b/docs/searching.md
index 63a9e296..0cbb61c7 100644
--- a/docs/searching.md
+++ b/docs/searching.md
@@ -1,4 +1,4 @@
-# Keyboard Shortcuts
+# Search & Shortcuts
## Searching
@@ -10,11 +10,11 @@ You can navigate through your items or search results using the keyboard. You ca
## Launching Apps
-You can launch a elected app by hitting <kbd>Enter</kbd>. This will open the app using your default opening method, specified in `target` (either `newtab`, `sametab`, `modal`, `top` or `workspace`). You can also use <kbd>Alt</kbd> + <kbd>Enter</kbd> to open the app in a pop-up modal, or <kbd>Ctrl</kbd> + <kbd>Enter</kbd> to open it in a new tab. For all available opening methods, just right-click on an item, to bring up the context menu.
+You can launch a elected app by hitting <kbd>Enter</kbd>. This will open the app using your default opening method, specified in `target` (one of `newtab`, `sametab`, `parent`, `top`, `modal`, `workspace`, `clipboard` or `newwindow`). You can also use <kbd>Alt</kbd> + <kbd>Enter</kbd> to open the app in a pop-up modal, or <kbd>Ctrl</kbd> + <kbd>Enter</kbd> to open it in a new tab. For all available opening methods, just right-click on an item, to bring up the context menu.
## Tags
-By default, items are filtered by the `title` attribute, as well as the hostname (extracted from `url`), the `provider` and `description`. If you need to find results based on text which isn't included in these attributes, then you can add `tags` to a given item.
+By default, when searching items are filtered by the `title`, (as well as the `url`, `provider` and `description`). If you need to find results based on text which isn't included in these attributes, then you can add `tags` to a given item.
```yaml
items:
@@ -53,14 +53,14 @@ In the above example, pressing <kbd>2</kbd> will launch Bookstack. Or hitting <k
## Web Search
-It's possible to search the web directly from Dashy, which might be useful if you're using Dashy as your start page. This can be done by typing your query as normal, and then pressing <kbd>⏎</kbd>. Web search options are configured under `appConfig.webSearch`.
+It's possible to launch a web search directly from Dashy, which might be useful if you're using Dashy as your start page. This can be done by typing your query as normal, and then pressing <kbd>⏎</kbd>/Enter. Web search options are configured under `appConfig.webSearch`.
### 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)
+- [`duckduckgo`](https://duckduckgo.com), [`google`](https://google.com), [`brave`](https://search.brave.com), [`kagi`](https://kagi.com), [`qwant`](https://www.qwant.com), [`startpage`](https://www.startpage.com)
+- [`perplexity`](https://www.perplexity.ai), [`uruky`](https://uruky.com), [`searx-tiekoetter`](https://searx.tiekoetter.com), [`ecosia`](https://www.ecosia.org), [`metager`](https://metager.org/meta), [`swisscows`](https://swisscows.com), [`mojeek`](https://www.mojeek.com), [`peekier`](https://peekier.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
@@ -82,9 +82,9 @@ In a similar way to opening apps, you can specify where you would like search re
### 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.
+An insanely useful feature of DDG is [Bangs](https://duckduckgo.com/bang), where you type a specific character combination as part 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. The bang can appear anywhere in the query. As long as the whole token is present, pressing Enter will launch that search bang
-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.
+This is configured 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:
@@ -103,7 +103,9 @@ appConfig:
':git': github
```
-Note that bangs begging with `!` or `:` must be surrounded them in quotes
+In the above example, when you type `:so how to exit vim` you'll be automatically sent to StackOverflow
+
+Note that bangs begging with `!` or `:` must be surrounded in quotes in the config (to keep it valid YAML)
### Disabling Web Search
@@ -114,9 +116,19 @@ appConfig:
webSearch: { disableWebSearch: true }
```
+When web search is disabled, pressing <kbd>Enter</kbd> opens the first matching item instead of web search. This will use that item's configured opening method
+
### Opening URLs Directly
-When enabled, if your search query looks like a URL (e.g. `github.com`, `https://example.org/path`), pressing <kbd>Enter</kbd> will navigate directly to that URL instead of searching for it.
+When enabled (with `appConfig.webSearch.openUrlsDirectly`), if your search query looks like a URL, pressing <kbd>Enter</kbd> will navigate directly to that URL instead of searching for it. Recognized formats include:
+
+- Full URLs with scheme: `https://example.org/path`
+- Dotted hostnames: `github.com`, `example.com:8080`, `example.com/path`
+- IP addresses: `192.168.1.1`, `192.168.1.1:8080`, `192.168.1.1/admin`
+- `localhost` (with optional port and/or path): `localhost`, `localhost:8080`
+- Bare hostnames when followed by a port or path: `nas:8080`, `router/setup`
+
+Note that a bare ambiguous word on its own (e.g. `nas`, `kubernetes`) is still treated as a search query, since the intent isn't clear.
Set `appConfig.webSearch.openUrlsDirectly` to `true`: