Skip to main content
VitePress Docs Support

Add an AI chatbot to your VitePress docs

ChattyBox turns VitePress documentation into a self-serve support assistant that answers from your published guides, API references, and examples with links back to the source pages.

Crawls published docs pages
Source-cited answers
Embeds with one script
No docs migration required
No credit card requiredYour content stays yours
Ask ChattyBox
x
Where should I start if I need a reliable answer from this site?
Start by adding your website URL to ChattyBox. It crawls your content, answers from the pages it finds, and shows visitors the sources behind each response.
iSources3^
VitePress guide
chattybox.ai
Analytics
chattybox.ai
Home
chattybox.ai
Ask a question...
Powered by ChattyBox
Built for VitePress teams

Launch a source-cited chatbot without rebuilding your docs stack

ChattyBox crawls your existing documentation, indexes the content for retrieval, and embeds a chatbot that answers using your docs instead of generic model memory.

Crawl VitePress-generated HTML routes, guides, API references, and examples.
Answer from deployed VitePress pages without rebuilding or migrating content.
Cite the exact guide, config page, or example used for each answer.
Use repeated questions to find VitePress sections that need clearer docs.
Workflow step

Enter your VitePress documentation URL or sitemap in ChattyBox.

Workflow step

Review crawled guides, API references, and versioned docs content.

Workflow step

Ask real support questions and verify citations point to the right pages.

Workflow step

Add the widget script to your VitePress theme or site shell.

Three-step launch

Paste your VitePress URL, test cited answers, then install the widget.

Build your VitePress chatbot
VitePress rollout

Use your existing VitePress content as the knowledge base

Teams choose VitePress for fast docs and polished developer experience. ChattyBox keeps that stack intact while making the content easier to query.

01

Crawl generated pages

Index public VitePress routes, guides, reference pages, and examples from your deployed site or sitemap.

02

Preserve docs ownership

Writers keep updating Markdown and the chatbot refreshes from the published source of truth.

03

Support versioned content

Use separate projects or clear URL scopes when you need different answers for different docs versions.

04

Embed without a rebuild

Add the widget script where custom JavaScript belongs in your VitePress theme or layout.

Install path

How to add ChattyBox to VitePress

Add the widget script in your VitePress theme entry so it loads beside the default theme after your docs have been crawled and tested.

  1. 1Create a ChattyBox project and enter your VitePress docs URL or sitemap.
  2. 2Review crawled guides, API references, examples, and versioned routes.
  3. 3Add the widget script in .vitepress/theme/index.ts so it loads on browser pages.
Build your VitePress chatbot
.vitepress/theme/index.ts
tsx
import DefaultTheme from 'vitepress/theme';
import { inBrowser } from 'vitepress';

export default {
  extends: DefaultTheme,
  enhanceApp() {
    if (!inBrowser) return;

    const script = document.createElement('script');
    script.src = 'https://chattybox.ai/widget.js';
    script.async = true;
    // Replace YOUR_API_KEY with your ChattyBox project API key.
    script.setAttribute('data-api-key', 'YOUR_API_KEY');
    script.setAttribute('data-api-url', 'https://adorable-woodpecker-629.convex.site/chat');
    script.setAttribute('data-chattybox-widget', 'true');
    document.body.appendChild(script);
  },
};
FAQ

Common questions

1

Can ChattyBox crawl VitePress docs?

Yes. ChattyBox can crawl public VitePress pages or a sitemap generated by your deployed docs site.

2

Will answers cite VitePress pages?

Yes. Answers can include links back to the exact guides, API pages, or examples used to respond.

3

Do I need to migrate from VitePress?

No. ChattyBox embeds beside your existing VitePress site and uses published pages as source content.

4

Can I test it before installing the widget?

Yes. Crawl your docs and test representative questions in the dashboard before adding the widget.

Start free

No credit card required. Your content is not used for model training.

Create free chatbot

Free tier. No card needed.