Przejdź do głównej treści
Docusaurus Pomoc dotycząca dokumentów

Dodaj chatbota AI do swojego Dokumentacja Docusaurus w kilka minut

Chatbot AI Docusaurus dla technical writerów, DevRel i zespołów wsparcia. ChattyBox przeszukuje dokumentację Docusaurus, odpowiada na pytania typu „Jak skonfigurować wersjonowanie?” na podstawie tych stron i cytuje wykorzystane źródło. Bez własnego RAG i bez migracji.

Indeksuje opublikowane strony dokumentacji
Odpowiedzi z cytowaniami źródeł
Osadzenie jednym skryptem
Bez migracji dokumentacji
Karta kredytowa nie jest wymaganaTwoje treści pozostają Twoje
Zapytaj ChattyBox
x
Od czego zacząć, jeśli potrzebuję wiarygodnej odpowiedzi z tej strony?
Zacznij od dodania adresu URL swojej strony do ChattyBox. Narzędzie indeksuje Twoje treści, odpowiada na podstawie znalezionych stron i pokazuje odwiedzającym źródła każdej odpowiedzi.
iŹródła3^
Docusaurus przewodnik
chattybox.ai
Analityka
chattybox.ai
Strona główna
chattybox.ai
Zadaj pytanie...
Obsługiwane przez ChattyBox
Konfiguracja samoobsługowa

Nie jest wymagana żadna rozmowa sprzedażowa

Niektóre narzędzia wsparcia AI wymagają rezerwacji wersji demonstracyjnej, zanim będziesz mógł przetestować produkt. ChattyBox jest samoobsługowy: dodaj swoją witrynę, przeszukaj dokumenty, przetestuj chatbota i osadź go, gdy będziesz gotowy.

Tradycyjne narzędzia wsparcia AIZarezerwuj demonstrację
ChattyBoxZacznij od razu
Tradycyjne narzędzia wsparcia AICeny ukryte lub zależne od sprzedaży
ChattyBoxCeny publiczne
Tradycyjne narzędzia wsparcia AISkoncentrowany na przedsiębiorstwach
ChattyBoxStworzony dla witryn z dokumentami, małych zespołów, OSS i SaaS
Tradycyjne narzędzia wsparcia AINajpierw rozmowa sprzedażowa
ChattyBoxNajpierw przetestuj to sam
Zbudowany dla Zespoły Docusaurus

Uruchom chatbota cytowanego w źródle bez konieczności ponownego tworzenia stosu dokumentów

ChattyBox przeszukuje istniejącą dokumentację, indeksuje treść w celu pobrania i osadza chatbota, który odpowiada, korzystając z dokumentów zamiast ogólnej pamięci modelu.

Opakowanie Root Docusaurus 3 ładuje widżet raz na cały okres istnienia aplikacji klienckiej.
Zakres indeksowania może podążać za bieżącymi, wersjonowanymi, zlokalizowanymi lub celowo filtrowanymi ścieżkami dokumentacji.
Cytaty kierują czytelników do wspierającej strony Docusaurus i zachowują jej wersję i ścieżkę ustawień regionalnych.
Powtarzalny przykład obejmuje zapobieganie duplikatom, nawigację klienta, CSP i weryfikację na poziomie trasy.
Krok przepływu pracy

Wybierz produkcyjną mapę witryny Docusaurus lub zamierzony zestaw bieżących, wersjonowanych i zlokalizowanych tras dokumentów.

Krok przepływu pracy

Przeszukaj wybrane trasy, a następnie przetestuj pytania pod kątem dokładnej wersji i lokalizacji, z której korzystają odwiedzający.

Krok przepływu pracy

Zainstaluj jeden trwały moduł ładujący w src/theme/Root.tsx i zezwól na jego skrypt i pochodzenie API w swojej Polityce bezpieczeństwa treści.

Krok przepływu pracy

Nawiguj między stronami dokumentów bez ponownego ładowania i sprawdzaj jedną instancję widżetu, działające cytaty oraz brak błędów konsoli lub CSP.

Uruchomienie w trzech krokach

Wklej swój adres URL Docusaurus, przetestuj cytowane odpowiedzi, a następnie zainstaluj widżet.

Stwórz swojego chatbota
Sprawdzone dowody redakcyjne

Przetestowana integracja Docusaurus 3, a nie skrypt na poziomie trasy

Docusaurus renderuje trwałą aplikację React wokół zmian tras po stronie klienta. Testowany wrapper Root tworzy zatem jeden moduł ładujący, rozpoznaje późniejsze montowania według identyfikatora i pozostawia moduł ładujący na miejscu, zamiast usuwać wciąż aktywny widżet podczas ponownego montowania w trybie programistycznym.

Autor techniczny
Zespół dokumentacji ChattyBox
Recenzent techniczny
Inżynieria ChattyBox
Ostatnia aktualizacja
Informacje sprawdzone
Docusaurus 3.10 i aktualny widżet ChattyBox

Sprawdź ponownie cykl życia Root, dane wyjściowe mapy witryny i pochodzenie CSP po ważnej aktualizacji Docusaurus lub zmianie punktu końcowego widżetu.

Docusaurus Komponent główny zapobiegający duplikowaniu skryptu ChattyBox po nawigacji klienta
Oryginalne odniesienie do instalacji: moduł ładujący ma stabilny identyfikator, ładuje asynchronicznie i pozostaje obecny, gdy Docusaurus zmienia trasy.
Docusaurus 3 decyzje dotyczące instalacji i ich kompleksowe kontrole.
Problem DocusaurusDecyzja wdrożeniowaWeryfikacja
Root i nawigacja po stronie klientaUtwórz raz skrypt asynchroniczny według stabilnego identyfikatora. Nie zwracaj efektu czyszczenia, ponieważ Root i widżet mają trwać na różnych trasach.Otwórz dwa wewnętrzne łącza do dokumentów i potwierdź, że document.querySelectorAll("#chattybox-widget").length ma wartość 1.
Polityka bezpieczeństwa treściZezwól na chattybox.ai w script-src, skonfigurowane pochodzenie API w connect-src, fonts.googleapis.com w style-src oraz fonts.gstatic.com w font-src. Obecny widżet wstrzykuje swój arkusz CSS komponentu, więc restrykcyjny style-src wymaga też 'unsafe-inline', dopóki nie będzie dostępna kompilacja obsługująca nonce lub zewnętrzny arkusz stylów.Przeładuj stronę przy otwartym DevTools i potwierdź brak zablokowanych żądań skryptów, stylów, czcionek, pobierania ani WebSocket.
Wersje, ustawienia regionalne i zakres mapy witrynyPrzed zaindeksowaniem sprawdź wdrożoną mapę witryny. Uwzględnij tylko obsługiwane ścieżki wersji i ustawień regionalnych lub użyj oddzielnych źródeł, jeśli odbiorcy nie mogą otrzymywać odpowiedzi dotyczących różnych wersji.Zadaj to samo pytanie specyficzne dla wydania w każdym indeksowanym języku i sprawdź, czy każdy cytat zachowuje oczekiwany przedrostek trasy.
Brakujący lub zduplikowany widżetSprawdź klucz API, identyfikator programu ładującego, komunikaty konsoli CSP, odpowiedź skryptu i czy inny komponent motywu również wstawia widżet.Przetestuj wersję produkcyjną, a nie tylko przeładuj na gorąco, i sprawdź panele Elements i Network po nawigacji.
Sprawdzanie cytowanych odpowiedzi

Przetestuj odpowiedź tam, gdzie liczy się ścieżka wydania

Przydatny test akceptacyjny pyta o ustawienie, którego odpowiedź może różnić się w zależności od wydania, a następnie otwiera cytat w celu sprawdzenia zarówno twierdzenia, jak i wersji URL.

Zapytaj dokumentację Docusaurus
x
Jak ustawić domyślne otwieranie najnowszych stabilnych dokumentów?
W konfiguracji wtyczki dokumentów ustaw lastVersion na wersję, którą odwiedzający powinni otworzyć, i użyj onlyIncludeVersions, gdy chcesz ograniczyć publikowane wydania. Zachowaj bieżącą trasę dokumentów tylko wtedy, gdy chcesz, aby użytkownicy mieli dostęp do niepublikowanej dokumentacji.
Zadaj pytanie...
Obsługiwane przez ChattyBox
Odpowiedź ChattyBox na temat domyślnej wersji Docusaurus z cytatem z przewodnika po wersji
Oryginalne odniesienie do wyniku: odpowiedź zawiera nazwę odpowiednich ustawień wersji i jako dowód przedstawia oficjalny przewodnik po wersji.
Ścieżka instalacji

Jak dodać ChattyBox do Docusaurus

Utwórz komponent główny motywu Docusaurus, dodaj skrypt widżetu po pobraniu dokumentów i wdróż. Odwiedzający mogą następnie zadawać pytania na dowolnej stronie dokumentów.

  1. 1Utwórz projekt ChattyBox i wprowadź adres URL lub mapę witryny dokumentów Docusaurus.
  2. 2Przetestuj prawdziwe pytania Docusaurus w panelu kontrolnym i potwierdź, że cytaty prowadzą do właściwych stron.
  3. 3Dodaj skrypt widgetu w src/theme/Root.tsx, aby ładował się w witrynie dokumentacji.
Stwórz swojego 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}</>;
}
Najczęstsze pytania

Często zadawane pytania

1

Czy ChattyBox może przeszukać witrynę Docusaurus?

Tak. ChattyBox może przeszukiwać publiczne strony dokumentacji Docusaurus lub używać adresu URL mapy witryny do odkrywania treści dokumentów.

2

Czy muszę zmienić motyw Docusaurus?

Nie. Osadzasz ChattyBox ze znacznikiem skryptu, aby działał on z istniejącym motywem i wdrożeniem Docusaurus.

3

Czy odpowiedzi będą prowadzić do stron Docusaurus?

Tak. Odpowiedzi mogą zawierać cytaty wskazujące użytkownikom dokładne strony dokumentacji użyte w odpowiedzi.

4

Czy mogę przetestować bota przed jego instalacją?

Tak. Możesz przetestować pobraną zawartość w panelu kontrolnym przed skopiowaniem fragmentu widżetu na swoją witrynę Docusaurus.

Zacznij bezpłatnie

Karta kredytowa nie jest wymagana. Twoje treści nie są używane do trenowania modeli.

Stwórz darmowego chatbota

Plan Free. Bez karty.