Neidio i'r prif gynnwys
Docusaurus Cefnogaeth Dogfennau

Ychwanegu chatbot AI at eich Dogfennau Docusaurus mewn munudau

Trowch eich dogfennau Docusaurus yn gynorthwyydd cymorth AI sy'n dyfynnu'r union dudalennau a ddefnyddiodd. Cadwch eich pentwr dogfennau, ychwanegwch un teclyn mewnosodadwy.

Crawls tudalennau dogfennau cyhoeddedig
Atebion ffynhonnell
Mewnosod gydag un sgript
Nid oes angen mudo dogfennau
Nid oes angen cerdyn credydMae eich cynnwys yn parhau'n eiddo i chi
Gofynnwch i ChattyBox
x
Ble ddylwn i ddechrau os oes angen ateb dibynadwy arnaf o'r wefan hon?
Dechreuwch trwy ychwanegu URL eich gwefan at ChattyBox. Mae'n cropian eich cynnwys, yn ateb o'r tudalennau y mae'n dod o hyd iddynt, ac yn dangos i ymwelwyr y ffynonellau y tu ôl i bob ymateb.
iFfynonellau3^
Docusaurus canllaw
chattybox.ai
Dadansoddeg
chattybox.ai
Cartref
chattybox.ai
Gofynnwch gwestiwn...
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 traddodiadolArchebwch demo
ChattyBoxDechreuwch yn syth
Offer cymorth AI traddodiadolPrisiau cudd neu werthiant
ChattyBoxPrisiau cyhoeddus
Offer cymorth AI traddodiadolYn canolbwyntio ar fenter
ChattyBoxWedi'i adeiladu ar gyfer gwefannau docs, timau bach, OSS, a SaaS
Offer cymorth AI traddodiadolSgwrs gwerthu yn gyntaf
ChattyBoxProfwch eich hun yn gyntaf
Adeiladwyd ar gyfer Docusaurus timau

Lansio chatbot a ddyfynnwyd yn ffynhonnell heb ailadeiladu eich pentwr dogfennau

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.

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.
Mae dyfyniadau yn dychwelyd darllenwyr i'r dudalen ategol Docusaurus ac yn cadw ei fersiwn a'i llwybr 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

Cropiwch 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 dogfennau heb ail-lwytho a gwiriwch un enghraifft teclyn, dyfyniadau gweithio, a dim gwallau consol neu CSP.

Lansiad tri cham

Gludwch eich URL Docusaurus, profwch yr atebion a ddyfynnir, yna gosodwch y teclyn.

Creu eich chatbot
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

Ailwirio cylch bywyd Root, allbwn map safle, a tharddiad CSP ar ôl uwchraddio mawr neu newid pwynt terfyn teclyn Docusaurus.

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
Root a llywio ar ochr y cleientCrë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 CynnwysCaniatewch 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 safleArchwiliwch 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 ddyblyguGwiriwch 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.
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.

Gofynnwch i'r dogfennau Docusaurus
x
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.
Gofynnwch gwestiwn...
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.
Gosod llwybr

Sut i ychwanegu ChattyBox at Docusaurus

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.

  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.
Creu eich chatbot
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?

Oes. Gall atebion gynnwys dyfyniadau sy'n cyfeirio defnyddwyr yn ôl at yr union dudalennau dogfennaeth a ddefnyddiwyd ar gyfer yr ymateb.

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.

Dechreuwch am ddim

Nid oes angen cerdyn credyd. Ni ddefnyddir eich cynnwys i hyfforddi modelau.

Creu chatbot am ddim

Haen am ddim. Dim angen cerdyn.