01
Crawl generated pages
Index public VitePress routes, guides, reference pages, and examples from your deployed site or sitemap.
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 pagesSource-cited answersEmbeds with one scriptNo docs migration requiredNo credit card requiredYour content stays yours
Launch a source-cited chatbot without rebuilding your site stack
ChattyBox crawls your existing website, documentation, help center, CMS, or knowledge base. Retrieved content can guide the chatbot’s answers; check answers and citations for accuracy.
Crawl VitePress-generated HTML routes, guides, API references, and examples.
Answer from deployed VitePress pages without rebuilding or migrating content.
Show retrieved guide, config, or example page links for supported answers.
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.
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.
Decision path
Use these checkpoints to decide whether ChattyBox should sit beside your docs platform, replace a separate assistant, or stay isolated for testing.
02
Preserve docs ownership
Writers keep updating Markdown. Refresh published content manually or enable scheduled refresh, subject to plan limits.
03
Support versioned content
Use a separate project for each docs version and review its indexed pages. URL scopes alone do not isolate retrieval by version; test representative questions.
04
Embed in your theme
Add the widget script where custom JavaScript belongs in your VitePress theme or layout, then rebuild and deploy your site.
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.
- 1Create a ChattyBox project and enter your VitePress docs URL or sitemap.
- 2Review crawled guides, API references, examples, and versioned routes.
- 3Add the widget script in .vitepress/theme/index.ts so it loads on browser pages.
.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);
},
};Explore next
More ways to use ChattyBox
01Platforms HubBrowse platform-specific AI chatbot pages for website builders, docs frameworks, CMS tools, help centers, and knowledge bases.02Source-Cited AI ChatbotLet users inspect retrieved source pages alongside supported AI answers.03Widget SetupInstall the ChattyBox widget on your website, docs, help center, or app shell.04Implementation GuideUse the step-by-step launch checklist for documentation chatbot rollout.
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?
Supported answers can link to retrieved guides, API pages, or examples; fallback responses may have no sources. Check answers and citations for accuracy.
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
Create free chatbot
Free tier. No card needed.