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.
Docusaurus Pomoc dotycząca dokumentów
Dodaj chatbota AI z cytowanymi źródłami do swojej dokumentacji Docusaurus
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 dokumentacjiOdpowiedzi z cytowaniami źródełOsadzenie jednym skryptemBez migracji dokumentacjiKarta kredytowa nie jest wymaganaTwoje treści pozostają Twoje
Zapytaj ChattyBox
xOd czego zacząć, jeśli potrzebuję wiarygodnej odpowiedzi z tej strony?
Zacznij od dodania adresu publicznej witryny do ChattyBox. Wyszukuje zindeksowane treści, aby ukierunkować odpowiedzi, i może pokazywać odnośniki do stron źródłowych do sprawdzenia przez odwiedzających. Przetestuj odpowiedzi i zachowanie awaryjne przed uruchomieniem.
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 AI
- Zarezerwuj demonstrację
- Ceny ukryte lub zależne od sprzedaży
- Skoncentrowany na przedsiębiorstwach
- Najpierw rozmowa sprzedażowa
Konfiguracja samoobsługowa
ChattyBox
- Zacznij od razu
- Ceny publiczne
- Stworzony dla witryn z dokumentami, małych zespołów, OSS i SaaS
- Najpierw przetestuj to sam
Zbudowany dla Zespoły Docusaurus
Uruchom chatbota z cytowaniami źródeł bez przebudowy stosu witryny
ChattyBox indeksuje istniejącą witrynę, dokumentację, centrum pomocy, CMS lub bazę wiedzy, a następnie osadza chatbota, który odpowiada na podstawie własnych opublikowanych treści 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.
1Krok przepływu pracy
Wybierz produkcyjną mapę witryny Docusaurus lub zamierzony zestaw bieżących, wersjonowanych i zlokalizowanych tras dokumentów.
2Krok 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.
3Krok 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.
4Krok 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.
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.
| Problem Docusaurus | Decyzja wdrożeniowa | Weryfikacja |
|---|---|---|
Problem Docusaurus Root i nawigacja po stronie klienta | Decyzja wdrożeniowa Utwórz raz skrypt asynchroniczny według stabilnego identyfikatora. Nie zwracaj efektu czyszczenia, ponieważ Root i widżet mają trwać na różnych trasach. | Weryfikacja Otwórz dwa wewnętrzne łącza do dokumentów i potwierdź, że document.querySelectorAll("#chattybox-widget").length ma wartość 1. |
Problem Docusaurus Polityka bezpieczeństwa treści | Decyzja wdrożeniowa Zezwó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. | Weryfikacja Przeładuj stronę przy otwartym DevTools i potwierdź brak zablokowanych żądań skryptów, stylów, czcionek, pobierania ani WebSocket. |
Problem Docusaurus Wersje, ustawienia regionalne i zakres mapy witryny | Decyzja wdrożeniowa Przed 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. | Weryfikacja Zadaj to samo pytanie specyficzne dla wydania w każdym indeksowanym języku i sprawdź, czy każdy cytat zachowuje oczekiwany przedrostek trasy. |
Problem Docusaurus Brakujący lub zduplikowany widżet | Decyzja wdrożeniowa Sprawdź klucz API, identyfikator programu ładującego, komunikaty konsoli CSP, odpowiedź skryptu i czy inny komponent motywu również wstawia widżet. | Weryfikacja 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.
Jak wybrać odpowiedniego chatbota treściowegoZapytaj dokumentację Docusaurus
xJak 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
Źródła pierwotne i dowody powtarzalne
Motyw Docusaurus Komponent główny motywuOficjalne wytyczne dotyczące komponentu najwyższego poziomu, którego nie można odmontować w trakcie nawigacji.Wersjonowanie dokumentacji DocusaurusOficjalne zachowanie bieżących dokumentów, zapisanych wersji, ścieżek wersji i wyboru wersji.Internacjonalizacja DocusaurusOficjalna kompilacja ustawień regionalnych i zlokalizowane wskazówki dotyczące URL.Wtyczka mapy witryny DocusaurusOficjalne opcje generowania, filtrowania i częstotliwości zmian mapy witryny.Uruchamialny przykład Docusaurus 3Wersjonowany przykład z trwałym loaderem Root, testowalnymi trasami i aktualnymi atrybutami widgetu.
Ś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.
- 1Utwórz projekt ChattyBox i wprowadź adres URL lub mapę witryny dokumentów Docusaurus.
- 2Przetestuj prawdziwe pytania Docusaurus w panelu kontrolnym i potwierdź, że cytaty prowadzą do właściwych stron.
- 3Dodaj skrypt widgetu w src/theme/Root.tsx, aby ładował się w witrynie dokumentacji.
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}</>;
}Zobacz dalej
Więcej sposobów użycia ChattyBox
01Chatbot AI do dokumentacjiZobacz, jak odpowiedzi oparte na źródłach działają w witrynach i platformach z dokumentacją techniczną.02Chatbot RAG dla treści witryny i dokumentacjiUruchom chatbota RAG dla swojej witryny i dokumentacji bez budowania infrastruktury pobierania. ChattyBox pobiera treści z Twoich źródeł i je cytuje.03Chatbot AI MkDocsPorównaj ten sam przepływ pracy z cytowanymi źródłami dla witryn MkDocs i Materiał dla witryn MkDocs.04Przeglądaj wszystkie przewodniki po platformachZnajdź przewodniki konfiguracji dla platform VitePress, Starlight, Nextra, Mintlify, ReadMe, Hugo i innych platform z dokumentacją.
Najczęstsze pytania
Często zadawane pytania
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.