Add docs
This commit is contained in:
parent
ac0ca8c14f
commit
bd28a872c1
@ -359,12 +359,14 @@ There are a few optional settings for the Quick Launch feature:
|
||||
|
||||
- `searchDescriptions`: which lets you control whether item descriptions are included in searches. This is off by default. When enabled, results that match the item name will be placed above those that only match the description.
|
||||
- `hideInternetSearch`: disable automatically including the currently-selected web search (e.g. from the widget) as a Quick Launch option. This is false by default, enabling the feature.
|
||||
- `hideSearchSuggestions`: disables search suggestions for the internet search. This is false by default, enabling the feature.
|
||||
- `hideVisitURL`: disable detecting and offering an option to open URLs. This is false by default, enabling the feature.
|
||||
|
||||
```yaml
|
||||
quicklaunch:
|
||||
searchDescriptions: true
|
||||
hideInternetSearch: true
|
||||
hideSearchSuggestions: true
|
||||
hideVisitURL: true
|
||||
```
|
||||
|
||||
|
||||
@ -17,7 +17,8 @@ or for a custom search:
|
||||
```yaml
|
||||
- search:
|
||||
provider: custom
|
||||
url: https://lougle.com/?q=
|
||||
url: https://www.ecosia.org/search?q=
|
||||
suggestionUrl: https://ac.ecosia.org/autocomplete?type=list&q=
|
||||
target: _blank
|
||||
```
|
||||
|
||||
@ -28,4 +29,25 @@ multiple providers is also supported via a dropdown (excluding custom):
|
||||
provider: [brave, google, duckduckgo]
|
||||
```
|
||||
|
||||
The response body for the URL provided with the `suggestionUrl` option should looke like this:
|
||||
|
||||
```json
|
||||
[
|
||||
"home",
|
||||
[
|
||||
"home depot",
|
||||
"home depot near me",
|
||||
"home equity loan",
|
||||
"homeworkify",
|
||||
"homedepot.com",
|
||||
"homebase login",
|
||||
"home depot credit card",
|
||||
"home goods"
|
||||
]
|
||||
]
|
||||
```
|
||||
|
||||
The first entry of the array contains the search query, the second one is an array of the suggestions.
|
||||
In the example above, the search query was **home**.
|
||||
|
||||
_Added in v0.1.6, updated in 0.6.0_
|
||||
|
||||
Loading…
Reference in New Issue
Block a user