A all ChattyBox gropian safle Docusaurus?
Oes. Gall ChattyBox gropian tudalennau dogfennaeth Docusaurus cyhoeddus neu ddefnyddio URL map gwefan i ddarganfod cynnwys dogfennau.
Trowch eich dogfennau Docusaurus yn gynorthwyydd cymorth AI sy'n dyfynnu'r union dudalennau a ddefnyddiodd. Cadwch eich pentwr dogfennau, ychwanegwch un teclyn mewnosodadwy.
Mae rhai offer cymorth AI yn gwneud ichi archebu demo cyn y gallwch chi hyd yn oed brofi'r cynnyrch. Mae ChattyBox yn hunanwasanaeth: ychwanegwch eich gwefan, cropian eich dogfennau, profwch y chatbot, a'i fewnosod pan fyddwch chi'n barod.
Mae ChattyBox yn cropian eich dogfennaeth bresennol, yn mynegeio'r cynnwys i'w adalw, ac yn mewnosod chatbot sy'n ateb gan ddefnyddio'ch docs yn lle cof model generig.
Dewiswch fap safle cynhyrchu Docusaurus neu set fwriadol o lwybrau dogfennaeth cyfredol, â fersiynau ac wedi'u lleoleiddio.
Cropiwch y llwybrau a ddewiswyd, yna profwch gwestiynau yn erbyn yr union ddatganiad a locale y mae eich ymwelwyr yn eu defnyddio.
Gosodwch un llwythwr parhaus yn src/theme/Root.tsx a chaniatáu ei sgript a'i darddiad API yn eich Polisi Diogelwch Cynnwys.
Llywiwch rhwng tudalennau dogfennau heb ail-lwytho a gwiriwch un enghraifft teclyn, dyfyniadau gweithio, a dim gwallau consol neu CSP.
Lansiad tri cham
Mae Docusaurus yn rendro cymhwysiad React parhaus o amgylch newidiadau llwybr ar ochr y cleient. Felly mae'r amlen Root a brofwyd yn creu un llwythwr, yn adnabod mowntiadau diweddarach drwy ID, ac yn gadael y llwythwr yn ei le yn hytrach na thynnu teclyn sy'n dal yn weithredol yn ystod ail-fowntio wrth ddatblygu.
Ailwirio cylch bywyd Root, allbwn map safle, a tharddiad CSP ar ôl uwchraddio mawr neu newid pwynt terfyn teclyn Docusaurus.
| Mater Docusaurus | Penderfyniad gweithredu | Dilysu |
|---|---|---|
| Root a llywio ar ochr y cleient | Crëwch y sgript async unwaith gan ddefnyddio ID sefydlog. Peidiwch â dychwelyd swyddogaeth glanhau o'r effaith gan fod Root a'r teclyn i fod i barhau ar draws llwybrau. | Agorwch ddau ddolen ddogfen fewnol a chadarnhewch mai 1 yw document.querySelectorAll("#chattybox-widget").length. |
| Polisi Diogelwch Cynnwys | Caniatewch chattybox.ai yn script-src, y tarddiad API wedi'i ffurfweddu yn connect-src, fonts.googleapis.com yn style-src, a fonts.gstatic.com yn font-src. Mae'r teclyn cyfredol yn chwistrellu ei CSS cydran, felly mae style-src llym hefyd angen 'unsafe-inline' hyd nes bod build sy'n ymwybodol o nonce neu ddalen arddull allanol ar gael. | Ail-lwythwch gyda DevTools agored a chadarnhewch nad oes unrhyw geisiadau sgript, nôl, na WebSocket wedi'u rhwystro. |
| Fersiynau, locales a chwmpas y map safle | Archwiliwch y map safle a ddefnyddiwyd cyn cropian. Cynhwyswch lwybrau rhyddhau a locale â chymorth yn unig, neu defnyddiwch ffynonellau ar wahân pan na ddylai cynulleidfaoedd gael atebion traws-fersiwn. | Gofynnwch yr un cwestiwn rhyddhau-benodol ym mhob locale mynegeio a gwiriwch fod pob dyfyniad yn cadw'r rhagddodiad llwybr disgwyliedig. |
| Teclyn ar goll neu wedi'i ddyblygu | Gwiriwch yr allwedd API, ID llwythwr, negeseuon consol CSP, ymateb sgript, ac a yw cydran thema arall hefyd yn chwistrellu'r teclyn. | Profwch adeiladwaith cynhyrchu, nid yn unig ail-lwytho poeth, ac archwiliwch y paneli Elements a Network ar ôl llywio. |
Mae prawf derbyn defnyddiol yn gofyn am osodiad y gall ei ateb amrywio yn ôl rhyddhau, yna mae'n agor y dyfyniad i wirio'r hawliad a'r URL fersiwn.
Creu cydran Root thema Docusaurus, ychwanegu'r sgript teclyn ar ôl i'ch dogfennau gael eu crafu, a'u defnyddio. Yna gall eich ymwelwyr ofyn cwestiynau o unrhyw dudalen dogfennau.
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}</>;
}Gweld sut mae atebion a ddyfynnir yn ffynhonnell yn gweithio ar draws safleoedd dogfennaeth dechnegol a llwyfannau.
Helpwch ddatblygwyr i ddatrys y gosodiadau, SDK, API, a chwestiynau gwall o'ch canllawiau yn gyflymach.
Cymharwch yr un llif gwaith a ddyfynnwyd yn ffynhonnell ar gyfer MkDocs a Deunydd ar gyfer safleoedd MkDocs.
Dewch o hyd i ganllawiau gosod ar gyfer platfformau VitePress, Starlight, Nextra, Mintlify, ReadMe, Hugo, a mwy o ddogfennau.
Oes. Gall ChattyBox gropian tudalennau dogfennaeth Docusaurus cyhoeddus neu ddefnyddio URL map gwefan i ddarganfod cynnwys dogfennau.
Na. Rydych chi'n mewnosod ChattyBox gyda thag sgript, felly mae'n gweithio ochr yn ochr â'ch thema a'ch defnydd Docusaurus presennol.
Oes. Gall atebion gynnwys dyfyniadau sy'n cyfeirio defnyddwyr yn ôl at yr union dudalennau dogfennaeth a ddefnyddiwyd ar gyfer yr ymateb.
Oes. Gallwch brofi cynnwys wedi'i grafu yn y dangosfwrdd cyn copïo'r pyt teclyn i'ch gwefan Docusaurus.
Nid oes angen cerdyn credyd. Ni ddefnyddir eich cynnwys i hyfforddi modelau.
Haen am ddim. Dim angen cerdyn.