Mixedbread Starlight

Mixedbread Search for Astro Starlight

A complete example implementation of [Mixedbread Search](https://www.mixedbread.com/blog/mixedbread-search) for Astro Starlight documentation sites. This project demonstrates how to replace Starlight's default Pagefind search with Mixedbread's powerful semantic search capabilities.

[](https://starlight.astro.build)

Prerequisites

Before you begin, you'll need:

• Node.js version 18 or higher
• Mixedbread Account - Sign up for free
• Mixedbread API Key - Get yours from the Mixedbread Dashboard
• Store ID - Create a store for your documentation

Quick Start

1. Clone the Repository

git clone https://github.com/mixedbread-ai/mixedbread-starlight.git
cd mixedbread-starlight

2. Install Dependencies

pnpm install

3. Configure Environment Variables

Create a `.env` file in the project root:

cp .env.example .env

Add your Mixedbread credentials:

MXBAI_API_KEY=your_api_key_here
MXBAI_STORE_ID=your_store_id_here

4. Sync Your Documentation

First, update the sync commands in `package.json` to use your store name:

{
  "scripts": {
    "docs:sync": "mxbai store sync \"mixedbread-starlight\" \"./src/content/**/*.mdx\" \"./src/content/**/*.md\"  --yes --strategy fast",
    "docs:sync:dry-run": "mxbai store sync \"mixedbread-starlight\" \"./src/content/**/*.mdx\" \"./src/content/**/*.md\" --dry-run"
  }
}

Replace `"mixedbread-starlight"` with your actual Mixedbread store name.

Now sync your documentation to Mixedbread store:

pnpm docs:sync

To preview changes before syncing:

pnpm docs:sync:dry-run

5. Start Development Server

pnpm dev

Integrating Into an Existing Project

Want to add Mixedbread Search to your existing S