Neidio i'r prif gynnwys
Docusaurus Cefnogaeth Dogfennau

Ychwanegwch chatbot AI sy'n dyfynnu ffynonellau at eich dogfennaeth Docusaurus

Chatbot AI Docusaurus ar gyfer awduron technegol, timau DevRel a chymorth. Mae ChattyBox yn cropian eich dogfennaeth Docusaurus a gall gysylltu atebion â thudalennau a adalwyd. Profwch gywirdeb atebion a dyfyniadau. Dim RAG pwrpasol na mudo.

Yn cropian tudalennau dogfennaeth cyhoeddedigAtebion sy'n dyfynnu ffynonellauMewnosod gydag un sgriptNid oes angen mudo dogfennauNid oes angen cerdyn credydMae eich cynnwys yn parhau'n eiddo i chi
Gofynnwch i ChattyBox
Ble ddylwn i ddechrau os oes angen ateb dibynadwy arnaf o'r wefan hon?
Dechreuwch drwy ychwanegu URL eich gwefan gyhoeddus at ChattyBox. Mae’n adalw cynnwys wedi’i fynegeio i arwain atebion a gall ddangos dolenni i dudalennau ffynhonnell i ymwelwyr eu harchwilio. Profwch atebion ac ymatebion wrth gefn cyn lansio.
iFfynonellau3^
Docusaurus canllaw
chattybox.ai
Dadansoddeg
chattybox.ai
Cartref
chattybox.ai

Sgwrs enghreifftiol — nid sgwrs fyw.

Wedi'i bweru gan ChattyBox
Gosodiad hunanwasanaeth

Nid oes angen galwad gwerthu

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.

Offer cymorth AI traddodiadol

  • Archebwch demo
  • Prisiau cudd neu werthiant
  • Yn canolbwyntio ar fenter
  • Sgwrs gwerthu yn gyntaf

Gosodiad hunanwasanaeth

ChattyBox

  • Dechreuwch yn syth
  • Prisiau cyhoeddus
  • Wedi'i adeiladu ar gyfer gwefannau docs, timau bach, OSS, a SaaS
  • Profwch eich hun yn gyntaf

Lansiwch chatbot â dyfyniadau ffynhonnell heb ailadeiladu pentwr eich gwefan

Mae ChattyBox yn cropian eich gwefan bresennol, dogfennaeth, canolfan gymorth, CMS neu sylfaen wybodaeth. Gall cynnwys a adferwyd arwain atebion y chatbot; gwiriwch atebion a dyfyniadau am gywirdeb.

Mae deunydd lapio Docusaurus 3 Root yn llwytho'r teclyn unwaith am oes y rhaglen cleient.
Gall cwmpas cropian ddilyn llwybrau dogfennaeth gyfredol, fersiynau, lleoledig neu wedi'u hidlo'n fwriadol.
Gall dyfyniadau gysylltu darllenwyr â thudalennau Docusaurus a adalwyd. Gwiriwch yr ateb a'r llwybr fersiwn a locale.
Mae'r enghraifft y gellir ei hatgynhyrchu yn ymdrin ag atal dyblyg, llywio cleientiaid, CSP, a dilysu lefel llwybr.
Cam llif gwaith

Dewiswch fap safle cynhyrchu Docusaurus neu set fwriadol o lwybrau dogfennaeth cyfredol, â fersiynau ac wedi'u lleoleiddio.

Cam llif gwaith

Ymlusgwch y llwybrau a ddewiswyd, yna profwch gwestiynau yn erbyn yr union ddatganiad a locale y mae eich ymwelwyr yn eu defnyddio.

Cam llif gwaith

Gosodwch un llwythwr parhaus yn src/theme/Root.tsx a chaniatáu ei sgript a'i darddiad API yn eich Polisi Diogelwch Cynnwys.

Cam llif gwaith

Llywiwch rhwng tudalennau dogfennaeth heb ail-lwytho a gwiriwch fod un achos o'r teclyn, bod y dyfyniadau'n gweithio, ac nad oes gwallau consol na CSP.

Lansiad tri cham

Gludwch eich URL Docusaurus, profwch atebion â dyfyniadau ffynhonnell, yna gosodwch y teclyn.

Tystiolaeth olygyddol wedi'i phrofi

Integreiddiad Docusaurus 3 profedig, nid sgript lefel llwybr

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.

Awdur technegol
Tîm Dogfennaeth ChattyBox
Adolygydd technegol
Peirianneg ChattyBox
Diweddarwyd diwethaf
Gwybodaeth wedi'i gwirio
Docusaurus 3.10 a'r teclyn ChattyBox cyfredol

Ailwiriwch gylch bywyd Root, allbwn y map gwefan a tharddiadau CSP ar ôl uwchraddiad mawr i Docusaurus neu newid i bwynt terfyn y teclyn.

Cydran Docusaurus Root atal sgript ChattyBox dyblyg ar ôl llywio cleient
Cyfeirnod gosod gwreiddiol: mae gan y llwythwr ID sefydlog, mae'n llwytho'n asyncronig, ac yn parhau i fod yn bresennol tra bod Docusaurus yn newid llwybrau.
Penderfyniadau gosod Docusaurus 3 a'u gwiriadau o'r dechrau i'r diwedd.
Mater DocusaurusPenderfyniad gweithreduDilysu
Mater Docusaurus
Root a llywio ar ochr y cleient
Penderfyniad gweithredu
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.
Dilysu
Agorwch ddau ddolen ddogfen fewnol a chadarnhewch mai 1 yw document.querySelectorAll("#chattybox-widget").length.
Mater Docusaurus
Polisi Diogelwch Cynnwys
Penderfyniad gweithredu
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.
Dilysu
Ail-lwythwch gyda DevTools ar agor a chadarnhewch nad oes unrhyw geisiadau sgript, arddull, ffont, nôl na WebSocket wedi'u rhwystro.
Mater Docusaurus
Fersiynau, locales a chwmpas y map safle
Penderfyniad gweithredu
Archwiliwch y map safle a ddefnyddiwyd cyn cropian. Cynhwyswch lwybrau rhyddhau a locale a gefnogir yn unig. Ar gyfer cwmpasau fersiwn ar wahân, defnyddiwch brosiectau ar wahân gyda'r tudalennau a fwriedir ym mhob un yn unig, a phrofwch am atebion traws-fersiwn.
Dilysu
Gofynnwch yr un cwestiwn rhyddhau-benodol ym mhob locale mynegeio a gwiriwch fod pob dyfyniad yn cadw'r rhagddodiad llwybr disgwyliedig.
Mater Docusaurus
Teclyn ar goll neu wedi'i ddyblygu
Penderfyniad gweithredu
Gwiriwch yr allwedd API, ID llwythwr, negeseuon consol CSP, ymateb sgript, ac a yw cydran thema arall hefyd yn chwistrellu'r teclyn.
Dilysu
Profwch adeiladwaith cynhyrchu, nid yn unig ail-lwytho poeth, ac archwiliwch y paneli Elements a Network ar ôl llywio.
Gwiriad ateb a ddyfynnwyd

Profwch ateb lle mae'r llwybr rhyddhau yn bwysig

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.

Rhestr wirio ymarferol ar gyfer gwerthuso sgwrsfotiau AI dogfennaeth
Gofynnwch i'r dogfennau Docusaurus
Sut mae gwneud i'r dogfennau sefydlog diweddaraf agor yn ddiofyn?
Yn y ffurfweddiad ategyn docs, gosodwch lastVersion i'r fersiwn y dylai ymwelwyr ei hagor a defnyddio onlyIncludeVersions pan fydd angen i chi gyfyngu ar ddatganiadau cyhoeddedig. Cadwch y llwybr dogfennau presennol dim ond os ydych chi am i ddefnyddwyr gyrchu dogfennaeth heb ei rhyddhau.

Sgwrs enghreifftiol — nid sgwrs fyw.

Wedi'i bweru gan ChattyBox
Ateb ChattyBox am y fersiwn ddiofyn Docusaurus gyda dyfyniad canllaw fersiwn
Cyfeirnod canlyniad gwreiddiol: mae'r ateb yn enwi'r gosodiadau fersiwn perthnasol ac yn amlygu'r canllaw fersiwn swyddogol fel tystiolaeth.
Llwybr gosod

Sut i ychwanegu ChattyBox at Docusaurus

Crëwch gydran Root thema Docusaurus, ychwanegwch sgript y teclyn ar ôl crafu'ch dogfennau, a chyhoeddwch y wefan. Yna gall eich ymwelwyr ofyn cwestiynau o unrhyw dudalen ddogfennaeth.

  1. 1Crëwch brosiect ChattyBox a rhowch eich URL docs Docusaurus neu fap gwefan.
  2. 2Profwch gwestiynau Docusaurus go iawn yn y dangosfwrdd a chadarnhewch y dyfyniadau sy'n pwyntio at y tudalennau cywir.
  3. 3Ychwanegwch y sgript teclyn yn src/theme/Root.tsx fel ei fod yn llwytho ar draws eich gwefan ddogfennaeth.
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}</>;
}
Cwestiynau cyffredin

Cwestiynau cyffredin

1

A all ChattyBox gropian safle Docusaurus?

Oes. Gall ChattyBox gropian tudalennau dogfennaeth Docusaurus cyhoeddus neu ddefnyddio URL map gwefan i ddarganfod cynnwys dogfennau.

2

Oes angen i mi newid fy thema Docusaurus?

Na. Rydych chi'n mewnosod ChattyBox gyda thag sgript, felly mae'n gweithio ochr yn ochr â'ch thema a'ch defnydd Docusaurus presennol.

3

A fydd yr atebion yn cysylltu'n ôl â thudalennau Docusaurus?

Gall atebion gynnwys dolenni i dudalennau dogfennaeth a adalwyd, ond efallai na fydd ffynonellau gan ymatebion wrth gefn. Gwiriwch gywirdeb atebion a dyfyniadau.

4

A allaf brofi'r bot cyn ei osod?

Oes. Gallwch brofi cynnwys wedi'i grafu yn y dangosfwrdd cyn copïo'r pyt teclyn i'ch gwefan Docusaurus.