Skip to content

Update links to Algolia documentation in configuration guide #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update links to Algolia documentation in configuration guide #238

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/content/1.getting-started/2.configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,15 @@ By default set to empty string. When set in the configuration object, it will us
By default set to true. Indicates whether to use 'algoliasearch-lite' or normal 'algoliasearch' package. Depending on your needs, if you only need to search you can set this option to true or do not set any option (it is by default true). But if you need more advances functionalities like multi queries, indexing, etc, you can set it to false to load full algoliasearch client.

::alert{type="info"}
You can get it [here](https://www.algolia.com/doc/api-client/getting-started/update-the-client/javascript/?client=javascript#search-onlylite-client)
You can get it [here](https://www.algolia.com/doc/libraries/sdk/upgrade/javascript#client-imports)
::

### `cache`

By default set to false. The client caches requests to Algolia and their responses.

::alert{type="info"}
More information available in the official [Algolia docs](https://www.algolia.com/doc/api-client/getting-started/customize/javascript/?client=javascript#caching-requests-and-responses).
More information available in the official [Algolia docs](https://www.algolia.com/doc/libraries/sdk/caching).
::

### `useFetch`
Expand All @@ -103,15 +103,15 @@ By default set to false. If set to true, it will use @algolia/requester-fetch in

### `instantSearch`

By default set to false. Indicates whether to install the official [vue-instantsearch](https://github.com/algolia/vue-instantsearch) plugin. This option can also be an object (see below).
By default set to false. Indicates whether to install the official [vue-instantsearch](https://github.com/algolia/instantsearch/tree/master/packages/vue-instantsearch) plugin. This option can also be an object (see below).

::alert{type="info"}
More information available in the official [Algolia docs](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/vue/).
::

### `instantSearch.theme`

By default set to `satellite`. Indicates which CSS theme to use for the [vue-instantsearch](https://github.com/algolia/vue-instantsearch) plugin. Valid values are `satellite`, `reset` or `algolia`.
By default set to `satellite`. Indicates which CSS theme to use for the [vue-instantsearch](https://github.com/algolia/instantsearch/tree/master/packages/vue-instantsearch) plugin. Valid values are `satellite`, `reset` or `algolia`.

::alert{type="info"}
More information available in the official [Algolia docs](https://www.algolia.com/doc/guides/building-search-ui/widgets/customize-an-existing-widget/vue/#style-your-widgets).
Expand Down
Loading