Hoppa till huvudinnehållet
Docusaurus docs-support

Lägg till en AI-chattbot med källhänvisningar i din Docusaurus-dokumentation

En Docusaurus AI-chattbot för tekniska skribenter, DevRel och supportteam. ChattyBox genomsöker din Docusaurus-dokumentation och kan länka svar till hämtade sidor. Kontrollera att svar och källhänvisningar är korrekta. Ingen egen RAG och ingen migrering.

Genomsöker publicerade dokumentsidorKällangivna svarBäddar in med ett skriptIngen dokumentmigrering krävsInget kreditkort krävsDitt innehåll förblir ditt
Fråga ChattyBox
Var ska jag börja om jag behöver ett tillförlitligt svar från den här webbplatsen?
Börja med att lägga till din offentliga webbplats-URL i ChattyBox. Tjänsten hämtar indexerat innehåll som stöd för svar och kan visa källänkar som besökare kan granska. Testa svar och reservsvar före lansering.
iKällor3^
Docusaurus vägledning
chattybox.ai
Analys
chattybox.ai
Hem
chattybox.ai

Illustrativ konversation — inte en livechatt.

Drivs av ChattyBox
Självbetjäningsinställning

Inget säljsamtal krävs

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.

Traditionella AI-stödverktyg

  • Boka en demo
  • Prissättning dold eller säljledd
  • Företagsfokuserad
  • Försäljningssamtal först

Självbetjäningsinställning

ChattyBox

  • Börja direkt
  • Offentlig prissättning
  • Byggd för dokumentwebbplatser, små team, OSS och SaaS
  • Testa själv först

Lansera en chatbot med källhänvisningar utan att bygga om webbplatsens stack

ChattyBox genomsöker din befintliga webbplats, dokumentation, ditt hjälpcenter, CMS eller din kunskapsbas. Hämtat innehåll kan vägleda chatbotens svar; kontrollera att svaren och källhänvisningarna är korrekta.

En Root-wrapper i Docusaurus 3 laddar widgeten en gång under klientapplikationens livstid.
Genomsökningsomfång kan följa aktuella, versionerade, lokaliserade eller avsiktligt filtrerade dokumentationsvägar.
Källhänvisningar kan länka läsare till hämtade Docusaurus-sidor. Kontrollera svaret samt sökvägen för version och språk.
Det reproducerbara exemplet täcker förebyggande av dubbletter, klientnavigering, CSP och verifiering på ruttnivå.
Arbetsflödessteg

Välj produktionswebbplatskartan för Docusaurus eller en avsiktlig uppsättning aktuella, versionerade och lokaliserade dokumentrutter.

Arbetsflödessteg

Genomsök de valda rutterna och testa sedan frågor mot den exakta versionen och lokaliseringen som dina besökare använder.

Arbetsflödessteg

Installera en beständig laddare i src/theme/Root.tsx och tillåt skriptets och API:ets ursprung i webbplatsens innehållssäkerhetspolicy.

Arbetsflödessteg

Navigera mellan dokumentsidor utan omladdning och verifiera en widgetinstans, fungerande citat och inga konsol- eller CSP-fel.

Lansering i tre steg

Klistra in din Docusaurus-URL, testa svar med källhänvisningar och installera sedan widgeten.

Testat redaktionellt underlag

En testad Docusaurus 3-integration, inte ett skript på ruttnivå

Docusaurus renderar en beständig React-applikation kring ruttändringar på klientsidan. Den testade Root-komponenten skapar därför en laddare, känner igen den via dess ID vid senare monteringar och lämnar den på plats i stället för att ta bort en fortfarande aktiv widget vid ommontering under utveckling.

Teknisk författare
ChattyBox dokumentationsteam
Teknisk granskare
ChattyBox Engineering
Senast uppdaterad
Information kontrollerad
Docusaurus 3.10 och nuvarande ChattyBox-widget

Kontrollera Root-livscykeln, webbplatskartans utdata och CSP-ursprungen igen efter en större Docusaurus-uppgradering eller en ändring av widgetens endpoint.

Docusaurus Root-komponent förhindrar en dubblett av ChattyBox-skript efter klientnavigering
Ursprunglig installationsreferens: laddaren har ett stabilt ID, laddas asynkront och ligger kvar när Docusaurus byter rutt.
Docusaurus 3 installationsbeslut och deras end-to-end-kontroller.
Docusaurus-aspektImplementeringsbeslutKontroll
Docusaurus-aspekt
Root och klientnavigering
Implementeringsbeslut
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.
Kontroll
Öppna två interna dokumentationslänkar och bekräfta att document.querySelectorAll("#chattybox-widget").length är 1.
Docusaurus-aspekt
Innehållssäkerhetspolicy
Implementeringsbeslut
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.
Kontroll
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.
Docusaurus-aspekt
Versioner, språkinställningar och webbplatskartor
Implementeringsbeslut
Inspektera den publicerade webbplatskartan innan den genomsöks. Inkludera endast sökvägar för versioner och språk som stöds. För separata versionsomfång, använd separata projekt med endast de avsedda sidorna i varje projekt och testa om svar hämtas från andra versioner.
Kontroll
Ställ samma versionsspecifika fråga på varje indexerat språk och kontrollera att varje källhänvisning behåller det förväntade ruttprefixet.
Docusaurus-aspekt
Widget saknas eller visas dubbelt
Implementeringsbeslut
Kontrollera API-nyckeln, laddar-ID, CSP-konsolmeddelanden, skriptsvar och om en annan temakomponent också injicerar widgeten.
Kontroll
Testa en produktionsbyggnad, inte bara omladdning, och inspektera panelerna Elements och Network efter navigering.
Kontroll av citerade svar

Testa ett svar där versionssökvägen spelar roll

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.

Praktisk checklista för att utvärdera AI-chattbotar för dokumentation
Fråga Docusaurus-dokumenten
Hur öppnar jag de senaste stabila dokumenten som standard?
Ställ in lastVersion i dokumentationspluginets konfiguration på den version som besökare ska öppna och använd onlyIncludeVersions när du behöver begränsa publicerade versioner. Behåll den aktuella dokumentationsrutten bara om användarna ska kunna nå dokumentation för ännu inte lanserade versioner.

Illustrativ konversation — inte en livechatt.

Drivs av ChattyBox
ChattyBox-svar om standardversionen av Docusaurus med en källhänvisning till versionsguiden
Ursprungligt resultatreferens: svaret namnger de relevanta versionsinställningarna och visar den officiella versionsguiden som bevis.
Installationsväg

Hur man lägger till ChattyBox till Docusaurus

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.

  1. 1Skapa ett ChattyBox-projekt och ange din Docusaurus docs-URL eller webbplatskarta.
  2. 2Testa verkliga Docusaurus-frågor i instrumentpanelen och kontrollera att källhänvisningarna pekar till rätt sidor.
  3. 3Lägg till widgetskriptet i src/theme/Root.tsx så att det laddas på din dokumentationswebbplats.
src/theme/Root.tsx
tsx
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}</>;
}
Vanliga frågor

Vanliga frågor

1

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.

2

Behöver jag ändra mitt Docusaurus-tema?

Nej. Du bäddar in ChattyBox med en skripttagg, så den fungerar bredvid ditt befintliga Docusaurus-tema och din deployment.

3

Länkar svar tillbaka till Docusaurus-sidor?

Svar kan länka till hämtade dokumentationssidor, men reservsvar kan sakna källor. Kontrollera att svar och källhänvisningar är korrekta.

4

Kan jag testa boten innan jag installerar den?

Ja. Du kan testa det insamlade innehållet i instrumentpanelen innan du kopierar widgetkoden till din Docusaurus-webbplats.