Voiko ChattyBox indeksoida Docusaurus-sivuston?
Kyllä. ChattyBox voi indeksoida julkisia Docusaurus dokumentaatiosivuja tai käyttää sivustokartan URL-osoitetta dokumenttien sisällön löytämiseen.
Docusaurus AI -chatbot teknisille kirjoittajille, DevRelille ja tukitiimeille. ChattyBox haravoi Docusaurus-dokumentaatiosi, vastaa kysymyksiin kuten "Kuinka määritän versioinnin?" näiltä sivuilta ja lainaa käyttämänsä lähteen. Ei omaa RAG-ratkaisua eikä siirtoa.
Jotkut tekoälyn tukityökalut saavat sinut varaamaan demon ennen kuin voit edes testata tuotetta. ChattyBox on itsepalvelu: lisää sivustosi, indeksoi asiakirjasi, testaa chatbotia ja upota se, kun olet valmis.
ChattyBox indeksoi olemassa olevan dokumentaatiosi, indeksoi sisällön haettavaksi ja upottaa chatbotin, joka vastaa käyttämällä asiakirjojasi yleisen mallimuistin sijaan.
Valitse Docusaurus-tuotantosivustokartta tai tarkoituksellinen joukko nykyisiä, versioituja ja lokalisoituja dokumenttireittejä.
Indeksoi valitut reitit ja testaa sitten kysymyksiä tarkan julkaisun ja vierailijoiden käyttämän kielen perusteella.
Asenna yksi pysyvä latausohjelma tiedostoon src/theme/Root.tsx ja salli sen komentosarjan ja API-alkuperät sisällön suojauskäytännössäsi.
Navigoi dokumenttisivujen välillä ilman uudelleenlatausta ja varmista, että yksi widget-esiintymä, toimivat lainaukset ja ei konsoli- tai CSP-virheitä.
Kolmivaiheinen käynnistys
Docusaurus tekee pysyvän React-sovelluksen asiakaspuolen reittimuutosten ympärille. Testattu Root-kääre luo siksi yhden latauslaitteen, tunnistaa myöhemmät asennukset tunnuksen perusteella ja jättää lataajan paikalleen sen sijaan, että se poistaisi vielä aktiivisen widgetin kehitysasennuksen aikana.
Tarkista Root-elinkaari, sivustokartan tulos ja CSP-alkuperät uudelleen Docusaurus-suuren päivityksen tai widgetin päätepisteen muutoksen jälkeen.
| Docusaurus huolenaihe | Täytäntöönpanopäätös | Vahvistus |
|---|---|---|
| Root- ja asiakasnavigointi | Luo async-skripti kerran vakaalla tunnuksella. Älä palauta puhdistusta tehosteesta, koska Root ja widget on tarkoitettu säilymään eri reiteillä. | Avaa kaksi sisäistä dokumenttilinkkiä ja varmista, että document.querySelectorAll("#chattybox-widget").length on 1. |
| Sisällön suojauskäytäntö | Salli chattybox.ai script-src:ssä, määritetty API-alkuperä connect-src:ssä, fonts.googleapis.com style-src:ssä ja fonts.gstatic.com font-src:ssä. Nykyinen widget injektoi oman komponenttinsa CSS:n, joten tiukka style-src tarvitsee myös 'unsafe-inline'n, kunnes nonce-tietoinen tai ulkoinen tyylitiedostokoontiversio on saatavilla. | Lataa sivu uudelleen DevTools auki ja varmista, ettei estettyjä komentosarja-, tyyli-, fontti-, haku- tai WebSocket-pyyntöjä ole. |
| Versiot, alueet ja sivustokartan laajuus | Tarkista käyttöön otettu sivustokartta ennen indeksointia. Sisällytä vain tuetut julkaisu- ja aluepolut tai käytä erillisiä lähteitä, kun yleisö ei saa saada eri versioiden vastauksia. | Esitä sama julkaisukohtainen kysymys jokaisessa indeksoidussa maassa ja tarkista, että jokainen lainaus säilyttää odotetun reitin etuliiteen. |
| Widget puuttuu tai kopioidaan | Tarkista API-avain, lataustunnus, CSP-konsolin viestit, komentosarjan vastaus ja lisääkö jokin muu teemakomponentti myös widgetin. | Testaa tuotantoversiota, ei vain kuumaa uudelleenlatausta, ja tarkasta Elements- ja Network-paneelit navigoinnin jälkeen. |
Hyödyllinen hyväksymistesti kysyy asetuksesta, jonka vastaus voi vaihdella julkaisuittain, ja avaa sitten sitaatin vahvistaakseen sekä väitteen että versioidun URL-osoitteen.
Luo Docusaurus-teeman juurikomponentti, lisää widget-skripti sen jälkeen, kun asiakirjasi on kaapattu, ja ota käyttöön. Vierailijasi voivat sitten esittää kysymyksiä miltä tahansa asiakirjasivulta.
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}</>;
}Katso, kuinka lähdeviittaukset toimivat teknisillä dokumentaatiosivustoilla ja alustoilla.
Auta kehittäjiä ratkaisemaan oppaidesi asennus-, SDK-, API- ja virhekysymykset nopeammin.
Vertaa samaa lähteeseen viitattua työnkulkua MkDocs- ja Material for MkDocs -sivustoille.
Löydä asennusoppaat VitePress-, Starlight-, Nextra-, Mintlify-, ReadMe-, Hugo- ja muille dokumenttialustoille.
Kyllä. ChattyBox voi indeksoida julkisia Docusaurus dokumentaatiosivuja tai käyttää sivustokartan URL-osoitetta dokumenttien sisällön löytämiseen.
Ei. Upota ChattyBox komentosarjatunnisteella, joten se toimii olemassa olevan Docusaurus-teeman ja käyttöönoton rinnalla.
Kyllä. Vastaukset voivat sisältää viittauksia, jotka ohjaavat käyttäjät takaisin täsmälleen vastauksessa käytetyille dokumentaatiosivuille.
Kyllä. Voit testata kopioitua sisältöä hallintapaneelissa ennen kuin kopioit widget-koodinpätkän Docusaurus-sivustollesi.
Luottokorttia ei vaadita. Sisältöäsi ei käytetä mallien kouluttamiseen.
Ilmainen taso. Ei korttia.