Lewati ke konten utama
Dukungan Dokumentasi Docusaurus

Tambahkan chatbot AI dengan kutipan sumber ke dokumentasi Docusaurus Anda

Chatbot AI Docusaurus untuk penulis teknis, DevRel, dan tim dukungan. ChattyBox merayapi dokumentasi Docusaurus Anda dan dapat menyertakan tautan ke halaman yang diambil dalam jawaban. Uji keakuratan jawaban dan kutipan. Tanpa RAG khusus dan tanpa migrasi.

Merayapi halaman dokumentasi yang dipublikasikanJawaban dengan sitasi sumberSematkan dengan satu skripTidak diperlukan migrasi dokumenTidak perlu kartu kreditKonten Anda tetap milik Anda
Tanya ChattyBox
Di mana saya harus mulai jika membutuhkan jawaban tepercaya dari situs ini?
Mulai dengan menambahkan URL situs publik Anda ke ChattyBox. Layanan ini mengambil konten terindeks untuk memandu jawaban dan dapat menampilkan tautan sumber untuk diperiksa pengunjung. Uji jawaban dan jawaban cadangan sebelum peluncuran.
iSumber3^
Docusaurus panduan
chattybox.ai
Analitik
chattybox.ai
Beranda
chattybox.ai

Percakapan ilustratif — bukan chat langsung.

Didukung oleh ChattyBox
Pengaturan layanan mandiri

Tidak diperlukan panggilan penjualan

Beberapa alat pendukung AI mengharuskan Anda memesan demo bahkan sebelum Anda dapat menguji produknya. ChattyBox bersifat mandiri: tambahkan situs Anda, jelajahi dokumen Anda, uji chatbot, dan sematkan saat Anda siap.

Alat pendukung AI tradisional

  • Pesan demo
  • Penetapan harga tersembunyi atau didorong oleh penjualan
  • Berfokus pada perusahaan
  • Percakapan penjualan terlebih dahulu

Pengaturan layanan mandiri

ChattyBox

  • Mulailah segera
  • Penetapan harga publik
  • Dibuat untuk situs dokumen, tim kecil, OSS, dan SaaS
  • Uji sendiri dulu

Luncurkan chatbot dengan kutipan sumber tanpa membangun ulang stack situs Anda

ChattyBox merayapi situs web, dokumentasi, pusat bantuan, CMS, atau basis pengetahuan yang sudah ada. Konten yang diambil dapat memandu jawaban chatbot; periksa keakuratan jawaban dan sitasinya.

Wrapper Root Docusaurus 3 memuat widget sekali selama masa aktif aplikasi klien.
Cakupan crawling dapat mengikuti jalur dokumentasi terkini, berversi, terlokalisasi, atau yang sengaja difilter.
Kutipan dapat mengarahkan pembaca ke halaman Docusaurus yang diambil. Periksa jawaban serta jalur versi dan locale-nya.
Contoh yang dapat direproduksi mencakup pencegahan duplikat, navigasi klien, CSP, dan verifikasi tingkat jalur.
Langkah alur kerja

Pilih sitemap Docusaurus produksi atau kumpulan jalur dokumentasi terkini, berversi, dan terlokalisasi yang ditentukan secara sengaja.

Langkah alur kerja

Lakukan crawling pada jalur yang dipilih, lalu uji pertanyaan terhadap rilis dan locale persis yang digunakan pengunjung Anda.

Langkah alur kerja

Instal satu loader persisten di src/theme/Root.tsx dan izinkan origin skrip serta API-nya dalam Content Security Policy Anda.

Langkah alur kerja

Navigasikan antarhalaman dokumentasi tanpa memuat ulang dan verifikasi satu instance widget, kutipan yang berfungsi, serta tidak adanya kesalahan konsol atau CSP.

Peluncuran tiga langkah

Tempelkan URL Docusaurus Anda, uji jawaban dengan sitasi sumber, lalu pasang widget.

Bukti editorial yang telah diuji

Integrasi Docusaurus 3 yang telah diuji, bukan skrip tingkat jalur

Docusaurus merender aplikasi React persisten saat terjadi perubahan jalur di sisi klien. Karena itu, wrapper Root yang diuji membuat satu loader, mengenali mount berikutnya berdasarkan ID, dan mempertahankan loader alih-alih menghapus widget yang masih aktif saat remount dalam pengembangan.

Penulis teknis
Tim Dokumentasi ChattyBox
Peninjau teknis
Tim Rekayasa ChattyBox
Terakhir diperbarui
Informasi diperiksa
Docusaurus 3.10 dan widget ChattyBox saat ini

Periksa kembali siklus hidup Root, output sitemap, dan origin CSP setelah upgrade mayor Docusaurus atau perubahan endpoint widget.

Komponen Root Docusaurus yang mencegah duplikasi skrip ChattyBox setelah navigasi klien
Referensi instalasi asli: loader memiliki ID stabil, dimuat secara asinkron, dan tetap ada saat Docusaurus mengubah jalur.
Keputusan instalasi Docusaurus 3 dan pemeriksaan menyeluruhnya.
Aspek DocusaurusKeputusan implementasiVerifikasi
Aspek Docusaurus
Root dan navigasi klien
Keputusan implementasi
Buat skrip async sekali berdasarkan ID stabil. Jangan kembalikan cleanup dari effect karena Root dan widget dimaksudkan untuk tetap ada di seluruh jalur.
Verifikasi
Buka dua tautan dokumentasi internal dan pastikan document.querySelectorAll("#chattybox-widget").length bernilai 1.
Aspek Docusaurus
Kebijakan Keamanan Konten
Keputusan implementasi
Izinkan chattybox.ai di script-src, origin API yang dikonfigurasi di connect-src, fonts.googleapis.com di style-src, dan fonts.gstatic.com di font-src. Widget saat ini menyisipkan CSS komponennya sendiri, sehingga style-src yang ketat juga memerlukan 'unsafe-inline' sampai build berbasis nonce atau stylesheet eksternal tersedia.
Verifikasi
Muat ulang dengan DevTools terbuka dan pastikan tidak ada permintaan script, style, font, fetch, atau WebSocket yang diblokir.
Aspek Docusaurus
Versi, locale, dan cakupan sitemap
Keputusan implementasi
Periksa sitemap yang telah di-deploy sebelum crawling. Sertakan hanya jalur rilis dan locale yang didukung. Untuk cakupan versi terpisah, gunakan proyek terpisah yang masing-masing hanya berisi halaman yang dimaksud, dan uji apakah ada jawaban lintas versi.
Verifikasi
Ajukan pertanyaan khusus rilis yang sama di setiap locale terindeks dan periksa bahwa setiap kutipan mempertahankan prefiks jalur yang diharapkan.
Aspek Docusaurus
Widget hilang atau duplikat
Keputusan implementasi
Periksa kunci API, ID loader, pesan konsol CSP, respons skrip, dan apakah komponen tema lain juga menyisipkan widget.
Verifikasi
Uji build produksi, bukan hanya hot reload, dan periksa panel Elements serta Network setelah navigasi.
Pemeriksaan jawaban dengan kutipan

Uji jawaban ketika jalur rilis berpengaruh

Pengujian penerimaan yang berguna menanyakan pengaturan yang jawabannya dapat berbeda menurut rilis, lalu membuka kutipan untuk memverifikasi klaim dan URL berversi.

Daftar periksa praktis untuk mengevaluasi chatbot AI dokumentasi
Tanyakan dokumentasi Docusaurus
Bagaimana cara membuka dokumentasi stabil terbaru secara default?
Dalam konfigurasi plugin dokumentasi, atur lastVersion ke versi yang harus dibuka pengunjung dan gunakan onlyIncludeVersions saat Anda perlu membatasi rilis yang dipublikasikan. Pertahankan jalur dokumentasi saat ini hanya jika Anda ingin pengguna mengakses dokumentasi yang belum dirilis.

Percakapan ilustratif — bukan chat langsung.

Didukung oleh ChattyBox
Jawaban ChattyBox tentang versi Docusaurus default dengan kutipan panduan pembuatan versi
Referensi hasil asli: jawaban menyebutkan pengaturan versi yang relevan dan menampilkan panduan pembuatan versi resmi sebagai bukti.
Jalur pemasangan

Bagaimana cara menambahkan ChattyBox ke Docusaurus

Buat komponen Root tema Docusaurus, tambahkan skrip widget setelah konten dokumentasi Anda diambil, lalu deploy. Pengunjung Anda kemudian dapat mengajukan pertanyaan dari halaman dokumentasi mana pun.

  1. 1Buat proyek ChattyBox dan masukkan URL dokumen atau peta situs Docusaurus Anda.
  2. 2Uji pertanyaan Docusaurus yang sebenarnya di dasbor dan konfirmasikan kutipan mengarah ke halaman yang tepat.
  3. 3Tambahkan skrip widget di src/theme/Root.tsx agar dapat dimuat di seluruh situs dokumentasi Anda.
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}</>;
}
Tanya Jawab

Pertanyaan umum

1

Bisakah ChattyBox merayapi situs Docusaurus?

Ya. ChattyBox dapat merayapi halaman dokumentasi Docusaurus publik atau menggunakan URL peta situs untuk menemukan konten dokumen.

2

Apakah saya perlu mengubah tema Docusaurus saya?

Tidak. Anda menyematkan ChattyBox dengan tag skrip, sehingga dapat berfungsi bersamaan dengan tema dan penerapan Docusaurus yang ada.

3

Akankah jawaban tertaut kembali ke halaman Docusaurus?

Jawaban dapat menyertakan tautan ke halaman dokumentasi yang diambil, tetapi jawaban fallback mungkin tidak memiliki sumber. Periksa keakuratan jawaban dan kutipannya.

4

Bisakah saya menguji bot sebelum memasangnya?

Ya. Anda dapat menguji konten yang diambil di dasbor sebelum menyalin cuplikan widget ke situs Docusaurus Anda.