{"_path":"/getting-started/configuration","_draft":false,"_partial":false,"_empty":false,"title":"Configuration","description":"","excerpt":{"type":"root","children":[{"type":"element","tag":"h2","props":{"id":"options"},"children":[{"type":"text","value":"Options"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can add custom configuration to the module like following:"}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n  modules: ['@nuxtjs/algolia'],\n  algolia: {\n    // options\n  }\n})\n","filename":"nuxt.config.js","language":"js"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"export default defineNuxtConfig({\n  modules: ['@nuxtjs/algolia'],\n  algolia: {\n    // options\n  }\n})\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Or"}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n  modules: [\n    ['@nuxtjs/algolia', {\n      // options\n    }]\n  ]\n})\n","filename":"nuxt.config.js","language":"js"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"export default defineNuxtConfig({\n  modules: [\n    ['@nuxtjs/algolia', {\n      // options\n    }]\n  ]\n})\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Defaults:"}]},{"type":"element","tag":"code","props":{"code":"{\n  apiKey: '<YOUR_SEARCH_API_KEY>',\n  applicationId: '<YOUR_APPLICATION_ID>',\n  globalIndex: '',\n  lite: true,\n  cache: false,\n  instantSearch: true, \n  useFetch: false,\n  crawler: {\n    apiKey: '<YOUR_API_KEY>',\n    indexName: '<YOUR_INDEX_NAME>',\n    meta: ['title', 'description'],\n    include: () => true\n  },\n  recommend: true,\n  indexer: {\n    storyblok: {\n      secret: 'INDEXER_SECRET',\n      algoliaAdminApiKey: 'ALGOLIA_ADMIN_KEY',\n      indexName: 'ALGOLIA_INDEX_NAME',\n      accessToken: 'STORYBLOK_ACCESS_TOKEN'\n    }\n  }\n}\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"{\n  apiKey: '<YOUR_SEARCH_API_KEY>',\n  applicationId: '<YOUR_APPLICATION_ID>',\n  globalIndex: '',\n  lite: true,\n  cache: false,\n  instantSearch: true, \n  useFetch: false,\n  crawler: {\n    apiKey: '<YOUR_API_KEY>',\n    indexName: '<YOUR_INDEX_NAME>',\n    meta: ['title', 'description'],\n    include: () => true\n  },\n  recommend: true,\n  indexer: {\n    storyblok: {\n      secret: 'INDEXER_SECRET',\n      algoliaAdminApiKey: 'ALGOLIA_ADMIN_KEY',\n      indexName: 'ALGOLIA_INDEX_NAME',\n      accessToken: 'STORYBLOK_ACCESS_TOKEN'\n    }\n  }\n}\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"For storing sensitive data such as API keys or Application ID variables we recommend using environment variables (apiKey is ALGOLIA_API_KEY and applicationId is ALGOLIA_APPLICATION_ID) that can later be loaded to Nuxt runtime config. Check out more "},{"type":"element","tag":"a","props":{"href":"https://nuxt.com/docs/migration/runtime-config#runtime-config","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"apikey"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apiKey"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This is the public API key to use in your frontend code. This key is only usable for search queries and sending data to the Insights API."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can read more about it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/security/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"applicationid"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"applicationId"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This is your unique application identifier. It's used to identify you when using Algolia's API."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can get it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/account/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"globalindex"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"globalIndex"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to empty string. When set in the configuration object, it will use this index name for all "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaSearch"}]},{"type":"text","value":" composables. Then, you do not need to pass the index name as a parameter of this composable."}]},{"type":"element","tag":"h3","props":{"id":"lite"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"lite"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"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."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can get it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/update-the-client/javascript/?client=javascript#search-onlylite-client","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"cache"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"cache"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to false. The client caches requests to Algolia and their responses."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"More information available in the official "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/customize/javascript/?client=javascript#caching-requests-and-responses","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia docs"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"usefetch"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useFetch"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to false. If set to true, it will use "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/requester-fetch","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"@algolia/requester-fetch"}]}]},{"type":"text","value":" instead of "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/requester-node-http","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"@algolia/requester-node-http"}]}]},{"type":"text","value":". This enables SSR-support for using this module in V8-based environments like Vercel Edge, Cloudflare Workers etc."}]},{"type":"element","tag":"h3","props":{"id":"instantsearch"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"instantSearch"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to false. Indicates whether to install the official "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/vue-instantsearch","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"vue-instantsearch"}]},{"type":"text","value":" plugin. This option can also be an object (see below)."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"More information available in the official "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/vue/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia docs"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"instantsearchtheme"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"instantSearch.theme"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"satellite"}]},{"type":"text","value":". Indicates which CSS theme to use for the "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/vue-instantsearch","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"vue-instantsearch"}]},{"type":"text","value":" plugin. Valid values are "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"satellite"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"reset"}]},{"type":"text","value":" or "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"algolia"}]},{"type":"text","value":"."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"More information available in the official "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/building-search-ui/widgets/customize-an-existing-widget/vue/#style-your-widgets","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia docs"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"crawler"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Indicates whether you would like the module to automatically index your pages when using Nuxt static site generation. Both the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apiKey"}]},{"type":"text","value":" and the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]},{"type":"text","value":" need to be set for this feature to be enabled."}]},{"type":"element","tag":"h4","props":{"id":"crawlerapikey"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.apiKey"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is not set. This is your private API key to use in your backend code. This key is used to update your Algolia index. "},{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"DO NOT USE YOUR ADMIN KEY!"}]},{"type":"text","value":" Instead use your admin key to generate another "},{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"limited"}]},{"type":"text","value":" key with at least the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"addObject"}]},{"type":"text","value":" and "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"deleteObject"}]},{"type":"text","value":" rights."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can read more about it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/security/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h4","props":{"id":"crawlerindexname"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.indexName"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is not set. This is the name of your Algolia index that will store all your pages' metadata."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can check out how to create a new index "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/importing-from-the-dashboard/#creating-a-new-index","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h4","props":{"id":"crawlermeta"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.meta"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is set to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"['title', 'description']"}]},{"type":"text","value":". This is the list of metafields that you would like to store when indexing a page. It can either be an array of fields or a function that returns an object of fields. The function should return a string and can be asynchronous."}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"{\n  ...\n  meta: ['title', 'description', 'lang']\n}\n","filename":"Array","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"{\n  ...\n  meta: ['title', 'description', 'lang']\n}\n"}]}]}]},{"type":"element","tag":"code","props":{"code":"{\n  ...\n  meta: async (html: string, route: string) => {\n    const result = await somePromise(route)\n\n    return {\n      ...result,\n      foo: 'bar'\n    }\n  }\n}\n","filename":"Function","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"{\n  ...\n  meta: async (html: string, route: string) => {\n    const result = await somePromise(route)\n\n    return {\n      ...result,\n      foo: 'bar'\n    }\n  }\n}\n"}]}]}]}]},{"type":"element","tag":"h4","props":{"id":"crawlerinclude"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.include"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is not set. This option is used to filter the pages that you would like to index by their route. It can either be an array of strings and/or regular expressions, or a function that should return a boolean. If the option is undefined, then all pages are indexed (default)."}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"{\n  ...\n  include: ['/foo', /^(?!\\/?admin).+/]\n}\n","filename":"Array","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"{\n  ...\n  include: ['/foo', /^(?!\\/?admin).+/]\n}\n"}]}]}]},{"type":"element","tag":"code","props":{"code":"{\n  ...\n  include: (route: string) => {\n    return !route.startsWith('admin')\n  }\n}\n","filename":"Function","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"{\n  ...\n  include: (route: string) => {\n    return !route.startsWith('admin')\n  }\n}\n"}]}]}]}]},{"type":"element","tag":"h3","props":{"id":"recommend"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"recommend"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"When set to true it will import the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@algolia/recommend"}]},{"type":"text","value":" library used for "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaRecommend"}]},{"type":"text","value":" composable to get the recommendations based on certain criteria."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can read more "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/products/recommendations/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"indexer"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexer"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configuration for automatic indexing of Algolia index by external Content Management System or another source. For now it supports only Storyblok but will support more in the future."}]},{"type":"element","tag":"h4","props":{"id":"indexerstoryblok"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexer.storyblok"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configuration object for using Storyblok as CMS provider in automatic indexing."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"secret"}]},{"type":"text","value":" used to verify if an automatic indexing can be triggered. It is a HTTP query sent via GET request and validated with a private runtime config property. Remember to add it to your webhook configuration."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"algoliaAdminApiKey"}]},{"type":"text","value":" used to populate Algolia index programatically."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]},{"type":"text","value":" name of the Algolia index that will be populated after the indexing."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"accessToken"}]},{"type":"text","value":" to Storyblok space."}]}]}]},"body":{"type":"root","children":[{"type":"element","tag":"h2","props":{"id":"options"},"children":[{"type":"text","value":"Options"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can add custom configuration to the module like following:"}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n  modules: ['@nuxtjs/algolia'],\n  algolia: {\n    // options\n  }\n})\n","filename":"nuxt.config.js","language":"js"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-c88c3d"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"({"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-7ab8bc"},"children":[{"type":"text","value":"modules"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":": ["}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'@nuxtjs/algolia'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"],"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-7ab8bc"},"children":[{"type":"text","value":"algolia"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    "}]},{"type":"element","tag":"span","props":{"class":"ct-13c3a7"},"children":[{"type":"text","value":"// options"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Or"}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n  modules: [\n    ['@nuxtjs/algolia', {\n      // options\n    }]\n  ]\n})\n","filename":"nuxt.config.js","language":"js"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-c88c3d"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"({"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-7ab8bc"},"children":[{"type":"text","value":"modules"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":": ["}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    ["}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'@nuxtjs/algolia'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":", {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"      "}]},{"type":"element","tag":"span","props":{"class":"ct-13c3a7"},"children":[{"type":"text","value":"// options"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    }]"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  ]"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Defaults:"}]},{"type":"element","tag":"code","props":{"code":"{\n  apiKey: '<YOUR_SEARCH_API_KEY>',\n  applicationId: '<YOUR_APPLICATION_ID>',\n  globalIndex: '',\n  lite: true,\n  cache: false,\n  instantSearch: true, \n  useFetch: false,\n  crawler: {\n    apiKey: '<YOUR_API_KEY>',\n    indexName: '<YOUR_INDEX_NAME>',\n    meta: ['title', 'description'],\n    include: () => true\n  },\n  recommend: true,\n  indexer: {\n    storyblok: {\n      secret: 'INDEXER_SECRET',\n      algoliaAdminApiKey: 'ALGOLIA_ADMIN_KEY',\n      indexName: 'ALGOLIA_INDEX_NAME',\n      accessToken: 'STORYBLOK_ACCESS_TOKEN'\n    }\n  }\n}\n","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"{"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  apiKey: "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'<YOUR_SEARCH_API_KEY>'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  applicationId: "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'<YOUR_APPLICATION_ID>'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  globalIndex: "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"''"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  lite: "}]},{"type":"element","tag":"span","props":{"class":"ct-5615cf"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  cache: "}]},{"type":"element","tag":"span","props":{"class":"ct-5615cf"},"children":[{"type":"text","value":"false"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  instantSearch: "}]},{"type":"element","tag":"span","props":{"class":"ct-5615cf"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":", "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  useFetch: "}]},{"type":"element","tag":"span","props":{"class":"ct-5615cf"},"children":[{"type":"text","value":"false"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  crawler: {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    apiKey: "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'<YOUR_API_KEY>'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    indexName: "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'<YOUR_INDEX_NAME>'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    meta: ["}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'title'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'description'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"],"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    include: () "}]},{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5615cf"},"children":[{"type":"text","value":"true"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  },"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  recommend: "}]},{"type":"element","tag":"span","props":{"class":"ct-5615cf"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  indexer: {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    storyblok: {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"      secret: "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'INDEXER_SECRET'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"      algoliaAdminApiKey: "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'ALGOLIA_ADMIN_KEY'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"      indexName: "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'ALGOLIA_INDEX_NAME'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"      accessToken: "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'STORYBLOK_ACCESS_TOKEN'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"For storing sensitive data such as API keys or Application ID variables we recommend using environment variables (apiKey is ALGOLIA_API_KEY and applicationId is ALGOLIA_APPLICATION_ID) that can later be loaded to Nuxt runtime config. Check out more "},{"type":"element","tag":"a","props":{"href":"https://nuxt.com/docs/migration/runtime-config#runtime-config","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"apikey"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apiKey"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This is the public API key to use in your frontend code. This key is only usable for search queries and sending data to the Insights API."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can read more about it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/security/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"applicationid"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"applicationId"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"This is your unique application identifier. It's used to identify you when using Algolia's API."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can get it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/account/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"globalindex"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"globalIndex"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to empty string. When set in the configuration object, it will use this index name for all "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaSearch"}]},{"type":"text","value":" composables. Then, you do not need to pass the index name as a parameter of this composable."}]},{"type":"element","tag":"h3","props":{"id":"lite"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"lite"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"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."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can get it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/update-the-client/javascript/?client=javascript#search-onlylite-client","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"cache"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"cache"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to false. The client caches requests to Algolia and their responses."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"More information available in the official "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/api-client/getting-started/customize/javascript/?client=javascript#caching-requests-and-responses","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia docs"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"usefetch"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useFetch"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to false. If set to true, it will use "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/requester-fetch","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"@algolia/requester-fetch"}]}]},{"type":"text","value":" instead of "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/requester-node-http","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"@algolia/requester-node-http"}]}]},{"type":"text","value":". This enables SSR-support for using this module in V8-based environments like Vercel Edge, Cloudflare Workers etc."}]},{"type":"element","tag":"h3","props":{"id":"instantsearch"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"instantSearch"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to false. Indicates whether to install the official "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/vue-instantsearch","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"vue-instantsearch"}]},{"type":"text","value":" plugin. This option can also be an object (see below)."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"More information available in the official "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/vue/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia docs"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"instantsearchtheme"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"instantSearch.theme"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default set to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"satellite"}]},{"type":"text","value":". Indicates which CSS theme to use for the "},{"type":"element","tag":"a","props":{"href":"https://github.com/algolia/vue-instantsearch","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"vue-instantsearch"}]},{"type":"text","value":" plugin. Valid values are "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"satellite"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"reset"}]},{"type":"text","value":" or "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"algolia"}]},{"type":"text","value":"."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"More information available in the official "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/building-search-ui/widgets/customize-an-existing-widget/vue/#style-your-widgets","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"Algolia docs"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"h3","props":{"id":"crawler"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Indicates whether you would like the module to automatically index your pages when using Nuxt static site generation. Both the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"apiKey"}]},{"type":"text","value":" and the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]},{"type":"text","value":" need to be set for this feature to be enabled."}]},{"type":"element","tag":"h4","props":{"id":"crawlerapikey"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.apiKey"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is not set. This is your private API key to use in your backend code. This key is used to update your Algolia index. "},{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"DO NOT USE YOUR ADMIN KEY!"}]},{"type":"text","value":" Instead use your admin key to generate another "},{"type":"element","tag":"em","props":{},"children":[{"type":"text","value":"limited"}]},{"type":"text","value":" key with at least the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"addObject"}]},{"type":"text","value":" and "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"deleteObject"}]},{"type":"text","value":" rights."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can read more about it "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/security/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h4","props":{"id":"crawlerindexname"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.indexName"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is not set. This is the name of your Algolia index that will store all your pages' metadata."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can check out how to create a new index "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/importing-from-the-dashboard/#creating-a-new-index","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h4","props":{"id":"crawlermeta"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.meta"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is set to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"['title', 'description']"}]},{"type":"text","value":". This is the list of metafields that you would like to store when indexing a page. It can either be an array of fields or a function that returns an object of fields. The function should return a string and can be asynchronous."}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"{\n  ...\n  meta: ['title', 'description', 'lang']\n}\n","filename":"Array","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"{"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  ..."}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  meta: ["}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'title'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'description'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'lang'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"]"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"{\n  ...\n  meta: async (html: string, route: string) => {\n    const result = await somePromise(route)\n\n    return {\n      ...result,\n      foo: 'bar'\n    }\n  }\n}\n","filename":"Function","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"{"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  ..."}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  meta: "}]},{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"async"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-7ab8bc"},"children":[{"type":"text","value":"html"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-be7bdd"},"children":[{"type":"text","value":"string"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-7ab8bc"},"children":[{"type":"text","value":"route"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-be7bdd"},"children":[{"type":"text","value":"string"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    "}]},{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-be7bdd"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ca2202"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-c88c3d"},"children":[{"type":"text","value":"somePromise"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-7ab8bc"},"children":[{"type":"text","value":"route"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    "}]},{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"      ..."}]},{"type":"element","tag":"span","props":{"class":"ct-7ab8bc"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"      "}]},{"type":"element","tag":"span","props":{"class":"ct-7ab8bc"},"children":[{"type":"text","value":"foo"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'bar'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"}"}]}]}]}]}]}]},{"type":"element","tag":"h4","props":{"id":"crawlerinclude"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"crawler.include"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"By default this option is not set. This option is used to filter the pages that you would like to index by their route. It can either be an array of strings and/or regular expressions, or a function that should return a boolean. If the option is undefined, then all pages are indexed (default)."}]},{"type":"element","tag":"code-group","props":{},"children":[{"type":"element","tag":"code","props":{"code":"{\n  ...\n  include: ['/foo', /^(?!\\/?admin).+/]\n}\n","filename":"Array","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"{"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  ..."}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  include: ["}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'/foo'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":","}]},{"type":"element","tag":"span","props":{"class":"ct-ca2202"},"children":[{"type":"text","value":" /"}]},{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"^"}]},{"type":"element","tag":"span","props":{"class":"ct-ca2202"},"children":[{"type":"text","value":"(?!\\/"}]},{"type":"element","tag":"span","props":{"class":"ct-5615cf"},"children":[{"type":"text","value":"?"}]},{"type":"element","tag":"span","props":{"class":"ct-ca2202"},"children":[{"type":"text","value":"admin)"}]},{"type":"element","tag":"span","props":{"class":"ct-7ab8bc"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-5615cf"},"children":[{"type":"text","value":"+"}]},{"type":"element","tag":"span","props":{"class":"ct-ca2202"},"children":[{"type":"text","value":"/"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"]"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"code","props":{"code":"{\n  ...\n  include: (route: string) => {\n    return !route.startsWith('admin')\n  }\n}\n","filename":"Function","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"{"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  ..."}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  include: ("}]},{"type":"element","tag":"span","props":{"class":"ct-7ab8bc"},"children":[{"type":"text","value":"route"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-be7bdd"},"children":[{"type":"text","value":"string"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":") "}]},{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"    "}]},{"type":"element","tag":"span","props":{"class":"ct-beda5b"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ca2202"},"children":[{"type":"text","value":"!"}]},{"type":"element","tag":"span","props":{"class":"ct-be7bdd"},"children":[{"type":"text","value":"route"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-c88c3d"},"children":[{"type":"text","value":"startsWith"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-d878f0"},"children":[{"type":"text","value":"'admin'"}]},{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"  }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-cc9610"},"children":[{"type":"text","value":"}"}]}]}]}]}]}]},{"type":"element","tag":"h3","props":{"id":"recommend"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"recommend"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"When set to true it will import the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"@algolia/recommend"}]},{"type":"text","value":" library used for "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useAlgoliaRecommend"}]},{"type":"text","value":" composable to get the recommendations based on certain criteria."}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can read more "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/products/recommendations/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]}]},{"type":"element","tag":"h3","props":{"id":"indexer"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexer"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configuration for automatic indexing of Algolia index by external Content Management System or another source. For now it supports only Storyblok but will support more in the future."}]},{"type":"element","tag":"h4","props":{"id":"indexerstoryblok"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexer.storyblok"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Configuration object for using Storyblok as CMS provider in automatic indexing."}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"secret"}]},{"type":"text","value":" used to verify if an automatic indexing can be triggered. It is a HTTP query sent via GET request and validated with a private runtime config property. Remember to add it to your webhook configuration."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"algoliaAdminApiKey"}]},{"type":"text","value":" used to populate Algolia index programatically."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"indexName"}]},{"type":"text","value":" name of the Algolia index that will be populated after the indexing."}]},{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"accessToken"}]},{"type":"text","value":" to Storyblok space."}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-ca2202{color:#56B6C2}.ct-be7bdd{color:#E5C07B}.ct-5615cf{color:#D19A66}.ct-13c3a7{color:#7F848E}.ct-d878f0{color:#98C379}.ct-7ab8bc{color:#E06C75}.ct-c88c3d{color:#61AFEF}.ct-cc9610{color:#ABB2BF}.ct-beda5b{color:#C678DD}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"options","depth":2,"text":"Options","children":[{"id":"apikey","depth":3,"text":"apiKey"},{"id":"applicationid","depth":3,"text":"applicationId"},{"id":"globalindex","depth":3,"text":"globalIndex"},{"id":"lite","depth":3,"text":"lite"},{"id":"cache","depth":3,"text":"cache"},{"id":"usefetch","depth":3,"text":"useFetch"},{"id":"instantsearch","depth":3,"text":"instantSearch"},{"id":"instantsearchtheme","depth":3,"text":"instantSearch.theme"},{"id":"crawler","depth":3,"text":"crawler"},{"id":"recommend","depth":3,"text":"recommend"},{"id":"indexer","depth":3,"text":"indexer"}]}]}},"_type":"markdown","_id":"content:1.getting-started:2.configuration.md","_source":"content","_file":"1.getting-started/2.configuration.md","_extension":"md"}