VitePress DepthIndex

VitePress DepthIndex is a production-grade, offline-first search and reasoning engine designed to turn standard documentation sites into AI-native experiences — running entirely on-device with zero server dependencies, no API keys, and zero latency.

Designed and developed by Eldrex Delos Reyes Bula ([email protected]).

📖 Full Documentation

For detailed installation guides, configuration schemas, API references, FAQs, and custom CSS styling templates, visit our official documentation site:

👉 https://depthindex.vercel.app

🎯 Key Features

• On-Device Hybrid Search: Combines BM25 exact keyword matching and dense TF-IDF Cosine similarity using sparse vector quantization.
• AI Conversational Assistant: Vue-based conversational UI overlay that provides responses, links citation highlights, and tracks local query personalization.
• PWA & Offline-First: Pre-registers a service worker (depthindex-sw.js) to cache and run search indexes and outlines without internet connections.
• LLMs.txt Generation: Automatically compiles metadata-rich summaries (llms.txt, llms-full.txt, and llms.jsonl) for AI crawling agents.
• 100% Privacy Compliance: No central servers, trackers, or telemetries. Optional cloud LLM API keys (OpenAI, Gemini, Anthropic) are stored locally in the browser's localStorage.

⚡ Quick Start

1. Install the Plugin

# npm
npm install vitepress-plugin-depthindex --save-dev

# pnpm
pnpm add -D vitepress-plugin-depthindex

2. Configure VitePress

Add the plugin to your .vitepress/config.ts:

import { defineConfig } from 'vitepress';
import DepthIndex from 'vitepress-plugin-depthindex';

export default defineConfig({
  title: 'My Docs Site',
  vite: {
    plugins: [
      DepthIndex({
        searchMode: 'on-device', // 'on-device' | 'hybrid' | 'cloud'
        offline: {
          enabled: true // Enable service worker caching
        }
      })
    ]
  }
});

🤝 Contributing & Code of Conduct

We welcome community extensions and fixes! Please review our Contributing Guidelines and Code of Conduct before making pull requests.

💖 Support & Donations

This plugin is free and open-source. If you enjoy using DepthIndex, please consider supporting the project:

• PayPal Support Link: paypal.me/eldrexbula
• Author: Eldrex Delos Reyes Bula
• Email: [email protected]