# Docs

- ZBSearch: ZBSearch for your browser

  - **Getting Started**
  - [Introduction](/docs/zbsearch): A complete search engine and RAG pipeline in your browser, server or edge network with support for full-text, vector, and hybrid search in less than 2kb.
  - [ZBSearch vs Orama](/docs/zbsearch/vs-orama): Head-to-head performance and search-quality benchmarks comparing ZBSearch and Orama on the same workloads.
  - Usage
    - [Create a new ZBSearch instance](/docs/zbsearch/usage/create): Create a new ZBSearch instance to store and search documents.
    - [Insert Data](/docs/zbsearch/usage/insert): Insert data into an ZBSearch database.
    - [Remove data](/docs/zbsearch/usage/remove): Learn how to remove data from an ZBSearch database.
    - [Update data](/docs/zbsearch/usage/update): Learn how to update data in ZBSearch.
    - [Save and Load](/docs/zbsearch/usage/serialization): Persist an ZBSearch database and restore it without freezing the main thread.
    - [Utility functions for ZBSearch](/docs/zbsearch/usage/utilities): Learn how to use utility functions in ZBSearch.
  - Search
    - [Introduction to search](/docs/zbsearch/search): Learn how to search through your documents with ZBSearch.
    - [Autocomplete](/docs/zbsearch/search/autocomplete): The suggest function returns ranked query completions for a partially typed term, to power autocomplete dropdowns.
    - [Changing Default Search Algorithm](/docs/zbsearch/search/changing-default-search-algorithm): Choosing between BM25, QPS, and PT15 for your search needs.
    - [Vector Search](/docs/zbsearch/search/vector-search): Learn how to perform vector search using ZBSearch.
    - [Hybrid Search](/docs/zbsearch/search/hybrid-search): Learn how to perform hybrid search in ZBSearch.
    - [Fields Boosting](/docs/zbsearch/search/fields-boosting): Learn how to boost the importance of a field in the search results.
    - [Facets](/docs/zbsearch/search/facets): Learn how to use facets in ZBSearch search engine.
    - [Filters](/docs/zbsearch/search/filters): Learn how to use filters in ZBSearch search.
    - [Geosearch](/docs/zbsearch/search/geosearch): Learn how to perform geosearch queries in ZBSearch.
    - [Sorting](/docs/zbsearch/search/sorting): Learn how to sort the search results in ZBSearch.
    - [Grouping](/docs/zbsearch/search/grouping): Learn how to group search results in ZBSearch.
    - [Threshold](/docs/zbsearch/search/threshold): The threshold property is used to set the minimum/maximum number of results to return.
    - [Preflight Search](/docs/zbsearch/search/preflight): Preflight search is an ZBSearch feature that allows you to run a preliminary search query that will return just the number of results that match your query.
    - [BM25 Algorithm](/docs/zbsearch/search/bm25): Learn how ZBSearch uses the BM25 algorithm to calculate the relevance of a document when searching.
  - [Results Pinning (Merchandising)](/docs/zbsearch/results-pinning): Pin specific documents to a chosen position in the search results.

  - **Integrations**
  - Integrations
    - [Integrations](/docs/zbsearch/integrations): Drop ZBSearch into an existing framework or documentation site.
    - [Docusaurus](/docs/zbsearch/integrations/docusaurus): Make ZBSearch the default search engine of your Docusaurus site.
    - [Starlight](/docs/zbsearch/integrations/starlight): Make ZBSearch the search engine of your Astro Starlight site.
    - [VitePress](/docs/zbsearch/integrations/vitepress): Make ZBSearch the search engine of your VitePress site.
    - [React search box](/docs/zbsearch/integrations/searchbox-react): The ZBSearch search dialog as a standalone React component.
    - [Vue search box](/docs/zbsearch/integrations/searchbox-vue): The ZBSearch search dialog as a standalone Vue 3 component.
    - [Highlight](/docs/zbsearch/integrations/highlight): Highlight and trim search matches inside a text.
    - [Docs index](/docs/zbsearch/integrations/docs-index): Turn markdown into a ZBSearch index, and query it in the browser.

  - **Supported Languages**
  - [Officially Supported Languages](/docs/zbsearch/supported-languages): ZBSearch supports 34 languages out of the box in 8 different alphabets. For every language, ZBSearch provides a default tokenizer, stop-words, and stemmer.
  - [Using Chinese with ZBSearch](/docs/zbsearch/supported-languages/using-chinese-with-zbsearch): Learn how to use Chinese with ZBSearch.
  - [Using Japanese with ZBSearch](/docs/zbsearch/supported-languages/using-japanese-with-zbsearch): Learn how to use Japanese with ZBSearch.

  - **Advanced ZBSearch**
  - Internals
    - [Components](/docs/zbsearch/internals/components): Learn how to customize ZBSearch by using its components architecture.
    - [Utilities](/docs/zbsearch/internals/utilities): ZBSearch exposes some of its internal utility functions.
  - Plugins
    - [Plugin system](/docs/zbsearch/plugins): Learn how to extend ZBSearch with plugins.
    - [Writing your own plugins](/docs/zbsearch/plugins/writing-your-own-plugins): Learn how to write your own plugins in ZBSearch.
    - [Plugin Embeddings](/docs/zbsearch/plugins/plugin-embeddings): Generate embeddings for your documents offline and use them for vector search.
    - Plugin Data Persistence
      - [Plugin Data Persistence](/docs/zbsearch/plugins/plugin-data-persistence): Persist your ZBSearch database to disk or in-memory and restore it later.
      - [Storage Adapters](/docs/zbsearch/plugins/plugin-data-persistence/storage-adapters): Persist a ZBSearch snapshot into IndexedDB, S3, or any custom storage backend, then restore it back into memory.
    - [Plugin QPS](/docs/zbsearch/plugins/plugin-qps): Boost your search results with the Quantum Proximity Scoring algorithm.
    - [Plugin PT15](/docs/zbsearch/plugins/plugin-pt15): Boost your search results with the PT15 algorithm.
    - [Plugin Parsedoc](/docs/zbsearch/plugins/plugin-parsedoc): Learn how to use the Parsedoc plugin in ZBSearch.
    - [Plugin Match Highlight](/docs/zbsearch/plugins/plugin-match-highlight): Learn how to use the match highlight plugin in ZBSearch.
  - Text analysis
    - [Stemming](/docs/zbsearch/text-analysis/stemming): Learn how to use stemming in ZBSearch.
    - [Stop-words](/docs/zbsearch/text-analysis/stop-words): Learn how to use stop-words with ZBSearch.
- Deploy to Cloudflare: Run ZBSearch as a distributed search API on Cloudflare Workers and R2 (beta)
  - [Overview](/docs/cloudflare): Run ZBSearch as a distributed search API on Cloudflare Workers and R2 - full-text, vector, and hybrid search at the edge. Currently in beta.
  - [Setup](/docs/cloudflare/setup): Deploy ZBSearch Edge to Cloudflare Workers and R2 - step by step from zero to a live search API. Cloudflare deploy is currently in beta.
  - [API reference](/docs/cloudflare/api-reference): Complete REST API for ZBSearch Edge - indexes, documents, search, rebuild, and status endpoints. Cloudflare deploy is in beta.
  - [Indexing & rebuilds](/docs/cloudflare/indexing-and-rebuilds): How ZBSearch Edge appends WAL writes, builds immutable snapshots in R2, and makes documents searchable. Cloudflare deploy is in beta.
  - [Production](/docs/cloudflare/production): Harden ZBSearch Edge for production - authentication, external rebuilds, GitHub Actions, and operational guidance. Cloudflare deploy is in beta.
  - [Cost calculator](/docs/cloudflare/cost-calculator): Estimate the monthly Cloudflare bill for a ZBSearch Edge deployment - Workers requests and CPU, R2 storage and operations, and Durable Objects, from measured baselines.
  - [Benchmarks](/docs/cloudflare/benchmarks): Load-test ZBSearch Edge with the k6 harness in benchmarks/http - corpus generation, timed ingest, search/write/mixed/coldstart scenarios, and CI. Cloudflare deploy is in beta.
  - [Local development](/docs/cloudflare/local-development): Run and test ZBSearch Edge locally with Wrangler dev, the rebuild CLI, and the monorepo test suite. Cloudflare deploy is in beta.