Kan ChattyBox crawla en Docusaurus-webbplats?
Ja. ChattyBox kan crawla offentliga Docusaurus-dokumentationssidor eller använda en sitemap-URL för att hitta docs-innehåll.
En Docusaurus AI-chattbot för tekniska skribenter, DevRel och supportteam. ChattyBox genomsöker din Docusaurus-dokumentation, besvarar frågor som “Hur konfigurerar jag versionshantering?” från dessa sidor och citerar källan den använde. Ingen egen RAG och ingen migrering.
Vissa AI-stödverktyg gör att du bokar en demo innan du ens kan testa produkten. ChattyBox är självbetjäning: lägg till din webbplats, genomsök dina dokument, testa chatboten och bädda in den när du är redo.
ChattyBox crawlar din befintliga dokumentation, indexerar innehållet för hämtning och bäddar in en chattbot som svarar med dina docs i stället för generiskt modellminne.
Välj produktionswebbplatskartan för Docusaurus eller en avsiktlig uppsättning aktuella, versionerade och lokaliserade dokumentrutter.
Genomsök de valda rutterna och testa sedan frågor mot den exakta versionen och lokaliseringen som dina besökare använder.
Installera en beständig laddare i src/theme/Root.tsx och tillåt skriptets och API:ets ursprung i webbplatsens innehållssäkerhetspolicy.
Navigera mellan dokumentsidor utan omladdning och verifiera en widgetinstans, fungerande citat och inga konsol- eller CSP-fel.
Lansering i tre steg
Docusaurus återger en beständig React-applikation kring ruttändringar på klientsidan. Det testade Root-omslaget skapar därför en laddare, känner igen senare monteringar med ID och lämnar laddaren på plats istället för att ta bort en fortfarande aktiv widget under utvecklingsremontering.
Kontrollera Root-livscykeln, webbplatskartans utdata och CSP-ursprungen igen efter en större Docusaurus-uppgradering eller en ändring av widgetens endpoint.
| Docusaurus-aspekt | Implementeringsbeslut | Kontroll |
|---|---|---|
| Root och klientnavigering | Skapa det asynkrona skriptet en gång med ett stabilt ID. Returnera ingen rensningsfunktion från effekten eftersom Root och widgeten ska finnas kvar mellan rutter. | Öppna två interna dokumentationslänkar och bekräfta att document.querySelectorAll("#chattybox-widget").length är 1. |
| Innehållssäkerhetspolicy | Tillåt chattybox.ai i script-src, det konfigurerade API-ursprunget i connect-src, fonts.googleapis.com i style-src och fonts.gstatic.com i font-src. Den aktuella widgeten injicerar sin komponent-CSS, så en strikt style-src behöver även 'unsafe-inline' tills en nonce-medveten eller extern stilmallsbyggnad är tillgänglig. | Ladda om med DevTools öppen och bekräfta att det inte finns några blockerade skript-, stil-, typsnitts-, hämtnings- eller WebSocket-förfrågningar. |
| Versioner, språkinställningar och webbplatskartor | Inspektera den distribuerade webbplatskartan innan den genomsöks. Inkludera endast sökvägar för versioner och språk som stöds, eller använd separata källor när publiken inte får ta emot svar i flera versioner. | Ställ samma versionsspecifika fråga i varje indexerad lokalitet och kontrollera att varje citat behåller det förväntade ruttprefixet. |
| Widget saknas eller visas dubbelt | Kontrollera API-nyckeln, laddar-ID, CSP-konsolmeddelanden, skriptsvar och om en annan temakomponent också injicerar widgeten. | Testa en produktionsbyggnad, inte bara omladdning, och inspektera panelerna Elements och Network efter navigering. |
Ett användbart godkännandetest frågar om en inställning vars svar kan skilja sig mellan versioner och öppnar sedan källhänvisningen för att verifiera både påståendet och den versionerade URL:en.
Skapa en rotkomponent för Docusaurus-tema, lägg till widgetskriptet efter att dina dokument har skrapats och distribuera. Dina besökare kan sedan ställa frågor från vilken dokumentsida som helst.
import React, { useEffect, type ReactNode } from 'react';
const WIDGET_ID = 'chattybox-widget';
export default function Root({ children }: { children: ReactNode }) {
useEffect(() => {
if (document.getElementById(WIDGET_ID)) return;
const script = document.createElement('script');
script.id = WIDGET_ID;
script.src = 'https://chattybox.ai/widget.js';
script.async = true;
script.dataset.apiKey = 'YOUR_API_KEY';
script.dataset.apiUrl = 'https://adorable-woodpecker-629.convex.site/chat';
script.dataset.chattyboxWidget = 'true';
document.body.appendChild(script);
}, []);
return <>{children}</>;
}Se hur källangivna svar fungerar på webbplatser och plattformar för teknisk dokumentation.
Hjälp utvecklare att lösa konfigurations-, SDK-, API- och felfrågor från dina guider snabbare.
Jämför samma källangivna arbetsflöde för MkDocs och Material för MkDocs-webbplatser.
Hitta installationsguider för VitePress, Starlight, Nextra, Mintlify, ReadMe, Hugo och fler dokumentplattformar.
Ja. ChattyBox kan crawla offentliga Docusaurus-dokumentationssidor eller använda en sitemap-URL för att hitta docs-innehåll.
Nej. Du bäddar in ChattyBox med en skripttagg, så den fungerar bredvid ditt befintliga Docusaurus-tema och din deployment.
Ja. Svar kan innehålla citat som skickar användare tillbaka till de exakta dokumentationssidor som användes för svaret.
Ja. Du kan testa scrapad content i instrumentpanelen innan du kopierar widgetsnutten till din Docusaurus-webbplats.
Inget kreditkort krävs. Ditt innehåll används inte för modellträning.
Free-nivå. Inget kort behövs.