1
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 Docs-tuki
Lisää lähdeviitteillä varustettu AI-chatbot Docusaurus-dokumentaatioosi
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.
Indeksoi julkaistut asiakirjasivutLähdeviittauksiaUpota yhdellä skriptilläAsiakirjojen siirtoa ei vaaditaLuottokorttia ei vaaditaSisältösi pysyy sinun
Kysy ChattyBoxilta
Mistä minun kannattaa aloittaa, jos tarvitsen luotettavan vastauksen tältä sivustolta?
Aloita lisäämällä julkisen sivustosi URL ChattyBoxiin. Se hakee indeksoitua sisältöä vastausten tueksi ja voi näyttää lähdesivulinkkejä kävijöiden tarkistettavaksi. Testaa vastaukset ja varavastaukset ennen julkaisua.
iLähteet3^
Docusaurus opas
chattybox.ai
Analytiikka
chattybox.ai
Etusivu
chattybox.ai
Havainnollistava keskustelu — ei live-chat.
Palvelun tarjoaa ChattyBox
Itsepalveluasennus
Myyntisoittoa ei tarvita
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.
Perinteiset tekoälyn tukityökalut
- Varaa demo
- Hinnoittelu piilotettu tai myyntilähtöinen
- Yrityskeskeinen
- Myyntikeskustelu ensin
Itsepalveluasennus
ChattyBox
- Aloita heti
- Julkinen hinnoittelu
- Suunniteltu dokumenttisivustoille, pienille ryhmille, OSS:lle ja SaaS:lle
- Testaa ensin itse
Lanseeraa lähdeviitteillä varustettu chatbot rakentamatta sivustosi pinoa uudelleen
ChattyBox indeksoi nykyisen verkkosivustosi, dokumentaatiosi, ohjekeskuksesi, CMS:si tai tietämyskantasi ja upottaa sitten chatbotin, joka vastaa omasta julkaistusta sisällöstäsi eikä mallin yleisen muistin perusteella.
Docusaurus 3 -juurikääre lataa widgetin kerran asiakassovelluksen käyttöiän ajan.
Indeksoinnin laajuus voi seurata nykyisiä, versioituja, lokalisoituja tai tarkoituksella suodatettuja dokumentaatioreittejä.
Sitaatit palauttavat lukijat tukevalle Docusaurus-sivulle ja säilyttävät sen version ja aluepolun.
Toistettavissa oleva esimerkki kattaa päällekkäisyyksien eston, asiakasnavigoinnin, CSP:n ja reittitason vahvistuksen.
Työnkulun vaihe
Valitse Docusaurus-tuotantosivustokartta tai tarkoituksellinen joukko nykyisiä, versioituja ja lokalisoituja dokumenttireittejä.
Työnkulun vaihe
Indeksoi valitut reitit ja testaa sitten kysymyksiä tarkan julkaisun ja vierailijoiden käyttämän kielen perusteella.
Työnkulun vaihe
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.
Työnkulun vaihe
Navigoi dokumenttisivujen välillä ilman uudelleenlatausta ja varmista, että yksi widget-esiintymä, toimivat lainaukset ja ei konsoli- tai CSP-virheitä.
Kolmivaiheinen käynnistys
Liitä Docusaurus URL-osoite, testaa lainatut vastaukset ja asenna sitten widget.
Testattu toimituksellinen näyttö
Testattu Docusaurus 3 -integraatio, ei reittitason komentosarja
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.
- Tekninen kirjoittaja
- ChattyBox-dokumentaatioryhmä
- Tekninen arvioija
- ChattyBoxin tekninen tiimi
- Viimeksi päivitetty
- Tiedot tarkistettu
- Docusaurus 3.10 ja nykyinen ChattyBox-widget
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 |
|---|---|---|
Docusaurus huolenaihe Root- ja asiakasnavigointi | Täytäntöönpanopäätös Luo async-skripti kerran vakaalla tunnuksella. Älä palauta puhdistusta tehosteesta, koska Root ja widget on tarkoitettu säilymään eri reiteillä. | Vahvistus Avaa kaksi sisäistä dokumenttilinkkiä ja varmista, että document.querySelectorAll("#chattybox-widget").length on 1. |
Docusaurus huolenaihe Sisällön suojauskäytäntö | Täytäntöönpanopäätös 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. | Vahvistus Lataa sivu uudelleen DevTools auki ja varmista, ettei estettyjä komentosarja-, tyyli-, fontti-, haku- tai WebSocket-pyyntöjä ole. |
Docusaurus huolenaihe Versiot, alueet ja sivustokartan laajuus | Täytäntöönpanopäätös 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. | Vahvistus Esitä sama julkaisukohtainen kysymys jokaisessa indeksoidussa maassa ja tarkista, että jokainen lainaus säilyttää odotetun reitin etuliiteen. |
Docusaurus huolenaihe Widget puuttuu tai kopioidaan | Täytäntöönpanopäätös Tarkista API-avain, lataustunnus, CSP-konsolin viestit, komentosarjan vastaus ja lisääkö jokin muu teemakomponentti myös widgetin. | Vahvistus Testaa tuotantoversiota, ei vain kuumaa uudelleenlatausta, ja tarkasta Elements- ja Network-paneelit navigoinnin jälkeen. |
Siteerattujen vastausten tarkistus
Testaa vastausta, jos julkaisupolulla on merkitystä
Hyödyllinen hyväksymistesti kysyy asetuksesta, jonka vastaus voi vaihdella julkaisuittain, ja avaa sitten sitaatin vahvistaakseen sekä väitteen että versioidun URL-osoitteen.
Kuinka valita oikean sisällön chatbotKysy Docusaurus-asiakirjoista
Kuinka saan uusimmat vakaat asiakirjat auki oletusarvoisesti?
Aseta dokumentaatiolaajennuksen määrityksissä lastVersion arvoksi versio, jonka haluat avautuvan vierailijoille, ja rajoita julkaistavia versioita tarvittaessa onlyIncludeVersions-asetuksella. Säilytä nykyisen dokumentaation reitti vain, jos haluat käyttäjien pääsevän julkaisemattomaan dokumentaatioon.
Havainnollistava keskustelu — ei live-chat.
Palvelun tarjoaa ChattyBox
Ensisijaiset lähteet ja toistettava näyttö
Docusaurus-teema JuurikomponenttiVirallinen opastus huipputason komponentille, joka ei irtoa navigoinnin aikana.Docusaurus-dokumenttien versiointiVirallinen toiminta nykyisille asiakirjoille, tallennetuille versioille, versiopoluille ja version valinnalle.Docusaurus kansainvälistyminenVirallinen kieliasetusten rakentaminen ja lokalisoitu URL-osoite.Sivukarttalaajennus DocusaurusViralliset sivustokartan luonti-, suodatus- ja muutostiheyden vaihtoehdot.Ajettava Docusaurus 3 -esimerkkiVersioitu esimerkki, jossa on pysyvä Root loader, testattavat reitit ja widgetin nykyiset attribuutit.
Asennuspolku
Kuinka lisätä ChattyBox Docusaurukseen
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.
- 1Luo ChattyBox-projekti ja kirjoita Docusaurus-dokumenttien URL-osoite tai sivustokartta.
- 2Testaa todellisia Docusaurus-kysymyksiä kojelaudassa ja varmista, että lainaukset osoittavat oikeille sivuille.
- 3Lisää widget-skripti tiedostoon src/theme/Root.tsx, jotta se latautuu koko dokumentaatiosivustollasi.
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}</>;
}Tutustu seuraavaksi
Lisää tapoja käyttää ChattyBoxia
01AI chatbot dokumentointia vartenKatso, kuinka lähdeviittaukset toimivat teknisillä dokumentaatiosivustoilla ja alustoilla.02RAG-chatbot verkkosivustolle ja dokumenteilleKäynnistä RAG-chatbot verkkosivustollesi ja dokumentaatiosi ilman hakutietuinfrastruktuurin rakentamista. ChattyBox hakee sisältösi joukosta ja lainaa lähteet.03MkDocs AI chatbotVertaa samaa lähteeseen viitattua työnkulkua MkDocs- ja Material for MkDocs -sivustoille.04Selaa kaikkia alustan oppaitaLöydä asennusoppaat VitePress-, Starlight-, Nextra-, Mintlify-, ReadMe-, Hugo- ja muille dokumenttialustoille.
UKK
Yleisiä kysymyksiä
2
Pitääkö minun vaihtaa Docusaurus teemani?
Ei. Upota ChattyBox komentosarjatunnisteella, joten se toimii olemassa olevan Docusaurus-teeman ja käyttöönoton rinnalla.
3
Linkitetäänkö vastaukset Docusaurus -sivuille?
Kyllä. Vastaukset voivat sisältää viittauksia, jotka ohjaavat käyttäjät takaisin täsmälleen vastauksessa käytetyille dokumentaatiosivuille.
4
Voinko testata bottia ennen sen asentamista?
Kyllä. Voit testata kopioitua sisältöä hallintapaneelissa ennen kuin kopioit widget-koodinpätkän Docusaurus-sivustollesi.