Přejít na hlavní obsah
Docusaurus Podpora Dokumentů

Přidejte AI chatbota ke svým dokumenty Docusaurus během několika minut

AI chatbot Docusaurus pro technické autory, DevRel a týmy podpory. ChattyBox prochází vaši dokumentaci Docusaurus, odpovídá na otázky jako „Jak nakonfiguruji verzování?“ přímo z těchto stránek a cituje zdroj, který použil. Žádné vlastní RAG a žádná migrace.

Prochází stránky publikovaných dokumentů
Odpovědi citované zdrojem
Vloží s jedním skriptem
Nevyžaduje se migrace dokumentů
Není vyžadována kreditní kartaVáš obsah zůstává váš
Zeptejte se ChattyBox
x
Kde mám začít, když potřebuji spolehlivou odpověď z tohoto webu?
Začněte přidáním adresy URL svého webu do ChattyBox. Prochází váš obsah, odpovídá ze stránek, které najde, a ukazuje návštěvníkům zdroje za každou odpovědí.
iZdroje3^
Docusaurus průvodce
chattybox.ai
Analytika
chattybox.ai
Domov
chattybox.ai
Zeptejte se...
Běží na ChattyBox
Samoobslužné nastavení

Není vyžadován žádný prodejní hovor

Některé podpůrné nástroje AI vás nutí zarezervovat si demo ještě předtím, než budete moci produkt otestovat. ChattyBox je samoobslužný: přidejte svůj web, procházejte své dokumenty, otestujte chatbota a vložte jej, až budete připraveni.

Tradiční nástroje podpory AIZarezervujte si demo
ChattyBoxZačněte hned
Tradiční nástroje podpory AISkryté ceny nebo ceny řízené prodejem
ChattyBoxVeřejné ceny
Tradiční nástroje podpory AIZaměřené na podniky
ChattyBoxVytvořeno pro weby s dokumenty, malé týmy, OSS a SaaS
Tradiční nástroje podpory AINejprve prodejní rozhovor
ChattyBoxNejprve si to otestujte sami
Vytvořeno pro Docusaurus týmy

Spusťte chatbota s citovaným zdrojem, aniž byste museli znovu sestavovat svůj zásobník dokumentů

ChattyBox prochází vaši stávající dokumentaci, indexuje obsah pro vyhledání a vkládá chatbota, který odpovídá pomocí vašich dokumentů namísto obecné paměti modelu.

Obalová komponenta Root v Docusaurus 3 načte widget jednou za celou dobu běhu klientské aplikace.
Rozsah procházení může sledovat aktuální, verzované, lokalizované nebo záměrně filtrované trasy dokumentace.
Citace vrátí čtenáře na příslušnou stránku Docusaurus a zachovají cestu její verze i jazyka.
Reprodukovatelný příklad pokrývá prevenci duplicit, navigaci klienta, CSP a ověřování na úrovni trasy.
Krok pracovního postupu

Vyberte produkční mapu webu Docusaurus nebo záměrnou sadu aktuálních, verzovaných a lokalizovaných tras dokumentů.

Krok pracovního postupu

Projděte vybrané trasy a poté otestujte otázky pro přesnou verzi a jazyk, které vaši návštěvníci používají.

Krok pracovního postupu

Nainstalujte jeden trvalý zavaděč do src/theme/Root.tsx a povolte původ jeho skriptu a API v zásadách zabezpečení obsahu.

Krok pracovního postupu

Procházejte mezi stránkami dokumentů bez opětovného načítání a ověřte jednu instanci widgetu, fungující citace a žádné chyby konzole nebo CSP.

Spuštění ve třech krocích

Vložte svou adresu URL Docusaurus, otestujte citované odpovědi a nainstalujte widget.

Vytvořte si chatbota
Ověřené redakční podklady

Testovaná integrace Docusaurus 3, nikoli skript na úrovni trasy

Docusaurus při změnách tras na straně klienta zachovává aplikaci React. Otestovaný obal Root proto vytvoří jediný zavaděč, pozdější připojení rozpozná podle ID a ponechá zavaděč na místě, aby při opakovaném připojení ve vývoji neodstranil stále aktivní widget.

Technický autor
Dokumentační tým ChattyBox
Technický recenzent
Technický tým ChattyBox
Naposledy aktualizováno
Informace zkontrolovány
Docusaurus 3.10 a aktuální widget ChattyBox

Po zásadním upgradu Docusaurus nebo změně koncového bodu widgetu znovu zkontrolujte životní cyklus Root, výstup mapy webu a původ CSP.

Komponenta Docusaurus Root bránící duplicitnímu skriptu ChattyBox po navigaci klienta
Původní instalační odkaz: zavaděč má stabilní ID, načítá se asynchronně a zůstává přítomen, zatímco Docusaurus mění trasy.
Docusaurus 3 rozhodnutí o instalaci a jejich end-to-end kontroly.
Oblast DocusaurusProváděcí rozhodnutíOvěření
Root a klientská navigaceVytvořte asynchronní skript jednou pomocí stabilního ID. Nevracejte vyčištění z efektu, protože Root a widget mají přetrvávat napříč trasami.Otevřete dva interní odkazy na dokumenty a potvrďte, že document.querySelectorAll("#chattybox-widget").length je 1.
Zásady zabezpečení obsahuPovolte chattybox.ai v script-src, nakonfigurovaný původ API v connect-src, fonts.googleapis.com ve style-src a fonts.gstatic.com ve font-src. Současný widget vkládá vlastní CSS komponenty, takže přísné style-src vyžaduje také 'unsafe-inline', dokud nebude k dispozici varianta s nonce nebo externím stylem.Načtěte stránku znovu s otevřeným DevTools a potvrďte, že nejsou blokovány žádné požadavky na skript, styl, font, načítání dat ani WebSocket.
Verze, národní prostředí a rozsah souboru SitemapPřed procházením zkontrolujte nasazenou mapu webu. Zahrňte pouze podporované cesty k vydání a národnímu prostředí nebo použijte samostatné zdroje, pokud publikum nesmí dostávat odpovědi napříč verzemi.Položte stejnou otázku specifickou pro vydání v každém indexovaném národním prostředí a zkontrolujte, zda každá citace zachovává očekávanou předponu trasy.
Chybějící nebo duplicitní widgetZkontrolujte klíč API, ID zavaděče, zprávy konzoly CSP, odezvu skriptu a zda další komponenta motivu také vkládá widget.Otestujte produkční sestavení, nejen opětovné načítání za běhu, a po navigaci zkontrolujte panely Elements a Network.
Kontrola citované odpovědi

Otestujte odpověď tam, kde na cestě k vydání záleží

Užitečný akceptační test se ptá na nastavení, jehož hodnota se může lišit podle vydání, a poté otevře citaci a ověří tvrzení i adresu URL dané verze.

Zeptejte se dokumentů Docusaurus
x
Jak mohu ve výchozím nastavení otevřít nejnovější stabilní dokumenty?
V konfiguraci pluginu docs nastavte lastVersion na verzi, kterou by návštěvníci měli otevřít, a použijte onlyIncludeVersions, když potřebujete omezit publikovaná vydání. Ponechejte aktuální směrování dokumentů pouze v případě, že chcete, aby uživatelé měli přístup k nevydané dokumentaci.
Zeptejte se...
Běží na ChattyBox
Odpověď ChattyBox o výchozí verzi Docusaurus s citací průvodce verzí
Odkaz na původní výsledek: odpověď uvádí příslušná nastavení verze a odhaluje oficiálního průvodce verzováním jako důkaz.
Instalační cesta

Jak přidat ChattyBox do Docusaurus

Vytvořte kořenovou komponentu motivu Docusaurus, přidejte skript widgetu poté, co jsou vaše dokumenty seškrábány, a nasaďte. Vaši návštěvníci pak mohou klást otázky z libovolné stránky dokumentů.

  1. 1Vytvořte projekt ChattyBox a zadejte adresu URL svého dokumentu Docusaurus nebo soubor Sitemap.
  2. 2Otestujte skutečné otázky Docusaurus na řídicím panelu a potvrďte, že citace směřují na správné stránky.
  3. 3Přidejte skript widgetu do src/theme/Root.tsx, aby se načetl na vašem webu s dokumentací.
Vytvořte si chatbota
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}</>;
}
Časté dotazy

Běžné otázky

1

Může ChattyBox procházet web Docusaurus?

Ano. ChattyBox může procházet veřejné stránky dokumentace Docusaurus nebo používat adresu URL souboru Sitemap k objevování obsahu dokumentů.

2

Musím změnit svůj motiv Docusaurus?

Ne. ChattyBox vložíte pomocí značky skriptu, takže funguje společně s vaším stávajícím motivem a nasazením Docusaurus.

3

Budou odpovědi odkazovat zpět na stránky Docusaurus?

Ano. Odpovědi mohou obsahovat citace, které uživatele nasměrují zpět na přesné stránky dokumentace použité pro odpověď.

4

Mohu robota před instalací otestovat?

Ano. Před zkopírováním úryvku widgetu na svůj web Docusaurus můžete otestovat zkopírovaný obsah na řídicím panelu.

Začněte zdarma

Není vyžadována kreditní karta. Váš obsah se nepoužívá k trénování modelů.

Vytvořte si chatbota zdarma

Tarif Free. Bez karty.