Search

Client-side search out of the box, with optional hosted and semantic backends.

Blume ships local search with no hosted infrastructure and no API keys. It runs in the browser, works in both blume dev and blume build, and indexes only your real content — navigation chrome and excluded pages are skipped. When you outgrow it, you can switch to a hosted or semantic backend without changing how search looks or behaves — only the search.provider you configure changes.

Blume reaches parity with Fumadocs’ provider set: Orama, FlexSearch, Algolia, Orama Cloud, Typesense, and Mixedbread (plus Pagefind). Only the configured provider’s SDK is installed into your project, so picking one backend never pulls in the others.

Using search

Open search with ⌘K (or Ctrl K), or press / when you’re not typing in a field. Esc closes it, and ⌘J (or Ctrl J) toggles the result preview pane.

Queries match page titles, descriptions, and body text, with title matches ranked highest and descriptions above body.

What’s indexed

For every indexable page, Blume indexes its title, description, and body reduced to plain text — code blocks, images, and markup are stripped, so results stay relevant. The index is built from your source files, so it’s identical in dev and production.

Providers

The client-side providers are keyless and need no extra config. The hosted ones take public credentials in blume.config.ts (safe to ship to the browser) and read their secret admin key from an environment variable at build time — the secret never lands in the config or the client bundle.

Orama (default)

Blume’s default engine. It builds a JSON index served at /blume-search.json and queries it in the browser — instant, client-side, and live in blume dev as you edit. No keys, no service.

search: {
  provider: "orama", // default
}

FlexSearch

A second keyless, client-side option. It reuses the same /blume-search.json index Orama ships and builds a FlexSearch document index in the browser. Works in blume dev and blume build.

search: {
  provider: "flexsearch",
}

Pagefind

For very large docs, opt into Pagefind. It indexes your built HTML and loads the index in shards on demand, keeping the initial payload tiny no matter how big the site grows.

search: {
  provider: "pagefind",
}

Pagefind only runs during blume build, so search isn’t available in blume dev with this provider.

Algolia

The browser queries Algolia directly with your search-only key. Each blume build replaces the index using the admin key from ALGOLIA_ADMIN_API_KEY (the build warns and skips the upload if it’s unset). The whole index is replaced on every sync, so pages you delete or rename don’t linger as stale results.

search: {
  provider: "algolia",
  algolia: {
    appId: "YOUR_APP_ID",
    indexName: "docs",
    searchApiKey: "YOUR_SEARCH_ONLY_KEY", // public
  },
}

Orama Cloud

Hosted Orama. The browser queries your index endpoint with the public API key; blume build pushes records to the index using ORAMA_PRIVATE_API_KEY. Set indexId to enable the sync.

search: {
  provider: "orama-cloud",
  oramaCloud: {
    endpoint: "https://cloud.orama.run/v1/indexes/your-index",
    apiKey: "YOUR_PUBLIC_API_KEY",
    indexId: "your-index-id", // for the build-time sync
  },
}

Typesense

Self-hosted or cloud Typesense. The browser queries the collection with the search-only key; blume build recreates the collection and imports documents using TYPESENSE_ADMIN_API_KEY. The collection is dropped and rebuilt on every sync so deleted or renamed pages don’t linger as stale results — if you hand-tune the collection’s settings, reapply them after a build.

search: {
  provider: "typesense",
  typesense: {
    host: "xyz.a1.typesense.net",
    collection: "docs",
    searchApiKey: "YOUR_SEARCH_ONLY_KEY", // public
    // port + protocol default to 443 / https
  },
}

Mixedbread

Semantic search via Mixedbread. Queries are proxied through a generated /api/search endpoint that holds your key, so this provider requires server output (deployment.output: "server"). The endpoint reads MIXEDBREAD_API_KEY. Sync your content to the store with the Mixedbread CLI in your build, e.g. mxbai vs sync <STORE_ID> ./content --ci.

search: {
  provider: "mixedbread",
  mixedbread: {
    storeId: "YOUR_STORE_ID",
  },
}

Disabling search

search: {
  provider: "none",
}

Excluding pages

Only indexable pages are searched. A page is left out of the index when it sets search.exclude in frontmatter:

search:
  exclude: true

Hidden pages are also excluded by default. To index them anyway, opt in:

search: {
  indexing: { includeHiddenPages: true },
}