V
Documentation Platforms

VitePress

AI-powered search and chat for VitePress sites

What is VitePress?

VitePress is a Vite and Vue-powered static site generator purpose-built for documentation. It is used by many Vue.js and Vite ecosystem projects to publish fast, lightweight documentation sites from Markdown.

Integration

How BeforeQuery works with VitePress

Everything you can do once the integration is connected.

Static site crawling

VitePress generates clean HTML from Markdown. BeforeQuery crawls the published static site and normalizes each page into searchable chunks.

Frontmatter metadata extraction

The BeforeQuery crawler extracts frontmatter-derived titles and descriptions to improve retrieval accuracy and citation quality.

Simple script tag embed

Add the BeforeQuery widget script to VitePress's head configuration. No custom component required.

Sync on CI deploy

Trigger a BeforeQuery sync from your GitHub Actions or Netlify/Vercel deploy pipeline after each VitePress build.

Setup

How to set it up

1

Add your deployed VitePress site URL as a source in BeforeQuery. The sitemap is used to discover all documentation pages.

2

Trigger the first crawl and review the indexed pages in the BeforeQuery dashboard to confirm coverage.

3

Add the widget script to VitePress's head config in .vitepress/config.ts to show the chat launcher on every page.

Ready to connect VitePress?

Start free. No credit card required. Connect your first integration in under 5 minutes.