Neidio i'r prif gynnwys
MkDocs Cefnogi Bot

Ychwanegwch chatbot AI sy'n dyfynnu ffynonellau at eich dogfennaeth MkDocs a Material

Chatbot AI ar gyfer dogfennaeth MkDocs a Material for MkDocs. Mae ChattyBox yn cropian eich gwefan gyhoeddus a gall gysylltu atebion â thudalennau a adalwyd. Profwch gywirdeb atebion a dyfyniadau. Dim piblinell fynegeio Python na RAG pwrpasol i'w gynnal.

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^
MkDocs canllaw
chattybox.ai
Dadansoddeg
chattybox.ai
Cartref
chattybox.ai

Sgwrs enghreifftiol — nid sgwrs fyw.

Wedi'i bweru gan ChattyBox

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'r gwrthwneud Material yn cadw JavaScript y thema ac yn ychwanegu un llwythwr teclyn asyncronaidd.
Mae Vanilla MkDocs yn defnyddio cyfeiriadur thema arfer ar wahân yn lle rhagdybio llwybrau Material.
Mae'r gwiriadau'n cynnwys chwilio ochr yn ochr â'r teclyn, llywio ar unwaith, llwythwyr dyblyg, a golygfannau symudol cul.
Mae detholiad cropian ymwybodol o fersiynau yn cadw llwybrau sefydlog, diweddaraf, ac etifeddiaeth mike yn fwriadol.
Cam llif gwaith

Ymlusgwch fap gwefan MkDocs sydd wedi'i gyhoeddi neu'r llwybrau sefydlog a fersiynedig rydych chi'n eu cefnogi'n fwriadol.

Cam llif gwaith

Profwch gwestiynau am y cynnyrch, Python ac API, ac agorwch bob dyfyniad cyn gosod.

Cam llif gwaith

Ar gyfer Material, ffurfweddwch theme.custom_dir ac ymestyn base.html o overrides/main.html tra'n cadw'r bloc sgriptiau gyda super().

Cam llif gwaith

Dilyswch chwiliad adeiledig, llywio ar unwaith, rheolyddion symudol, CSP, a phob fersiwn mike cyhoeddedig.

Lansiad tri cham

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

Llif gwaith penodol i MkDocs

Cefnogaeth sgwrsio ar gyfer safleoedd dogfennu Python statig

Mae timau MkDocs fel arfer eisiau adeiladau statig cyflym, llywio clir, a chynnwys technegol darllenadwy. Mae ChattyBox yn cadw'r llif gwaith hwnnw'n gyfan tra'n ychwanegu cynorthwyydd y cyfeiriwyd ato yn y ffynhonnell ar ben y wefan gyhoeddedig.

Llwybr penderfyniad

Defnyddiwch y pwyntiau gwirio hyn i benderfynu a ddylai ChattyBox eistedd wrth ymyl eich platfform docs, amnewid cynorthwyydd ar wahân, neu aros yn ynysig ar gyfer profi.

01

Yn gweithio gyda thudalennau Material for MkDocs

Mynegeiwch ganllawiau, tudalennau cyfeirio ac HTML statig a gynhyrchwyd o safleoedd cyhoeddus MkDocs neu Material for MkDocs heb ddisodli'ch thema.

02

Trin dogfennaeth fersiwn yn fwriadol

Pwyntiwch ChattyBox at y llwybrau fersiwn rydych chi am i ddefnyddwyr ofyn amdanynt, yna profwch a yw'r atebion yn dyfynnu'r dogfennau sefydlog, diweddaraf neu etifeddiaeth bwriedig.

03

Dim swydd mynegeio Python i'w chynnal

Gan fod ChattyBox yn cropian o'r safle cyhoeddus, nid oes angen i dimau ychwanegu mynegeio fector i'w piblinell adeiladu MkDocs neu sgriptiau CI.

04

Gwella dogfennau o gwestiynau go iawn

Ar Pro neu Business, adolygwch gwestiynau sydd wedi'u fflagio fel arwyddion hewristig o enghreifftiau a allai fod ar goll, camau gosod aneglur, neu dudalennau datrys problemau sydd wedi dyddio.

Tystiolaeth olygyddol wedi'i phrofi

Wedi profi llwybrau gosod Material a fanila MkDocs

Mae Material for MkDocs a thema barod MkDocs ill dau yn cefnogi etifeddu templedi, ond dylent ddefnyddio cyfeiriaduron personol ar wahân. Mae'r llwybr Material isod yn cadw ei floc scripts gyda super(), yn ychwanegu un llwythwr async, ac yn goroesi llywio ar unwaith heb ddisodli ymddygiad chwilio.

Awdur technegol
Tîm Dogfennaeth ChattyBox
Adolygydd technegol
Peirianneg ChattyBox
Diweddarwyd diwethaf
Gwybodaeth wedi'i gwirio
MkDocs, Material for MkDocs a mike

Ailwiriwch flociau templed ac ymddygiad llywio ar unwaith ar ôl uwchraddio'r thema, ac ailgropiwch pryd bynnag y bydd alias mike yn symud.

Ffurfweddiad custom_dir Material for MkDocs a gwrthwneud y prif dempled sy'n cadw sgriptiau'r thema
Cyfeirnod gosod gwreiddiol: Mae theme.custom_dir yn dewis y gwrthwneud ac mae super() yn cadw sgriptiau chwilio a llywio Material yn gyfan.
Penderfyniadau gosod Material a fanila MkDocs gyda gwiriadau diwedd-i-ddiwedd.
Mater MkDocsPenderfyniad gweithreduDilysu
Mater MkDocs
Gwrthwneud Material
Penderfyniad gweithredu
Gosodwch theme.name yn material a theme.custom_dir yn overrides. Estynnwch base.html, gwrthwneudwch scripts, galwch super(), ac yna atodwch sgript y teclyn.
Dilysu
Adeiladwch a gweinwch y safle, yna cadarnhewch fod chwilio a llywio Material yn dal i weithio.
Mater MkDocs
Fanila MkDocs
Penderfyniad gweithredu
Defnyddiwch theme.name: mkdocs gyda chyfeiriadur custom_theme ar wahân. Ychwanegwch y gwrthwneud custom_theme/main.html cyfatebol yn hytrach na chopïo templedi Material.
Dilysu
Rhedeg mkdocs serve a gwirio chwiliad, dolenni nesaf a blaenorol, a'r teclyn ar fwy nag un dudalen.
Mater MkDocs
Llwytho async a dyblygu
Penderfyniad gweithredu
Cadwch un llwythwr yn y bloc scripts a etifeddwyd, rhowch ID sefydlog iddo, a pheidiwch ag ychwanegu'r un snippet drwy extra_javascript neu ddarn arall.
Dilysu
Ar ôl llwythi llawn a thrawsnewidiadau sydyn Material, cadarnhewch mai 1 yw document.querySelectorAll("#chattybox-widget").length.
Mater MkDocs
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
Gwiriwch gonsol y porwr a'r panel Network am geisiadau sgript, arddull, ffont, nôl neu WebSocket sydd wedi'u rhwystro.
Mater MkDocs
Chwilio, llywio ar unwaith, a symudol
Penderfyniad gweithredu
Cadwch sgriptiau thema gyda super() a chadwch y lansiwr yn glir o'r deialog chwilio, y drôr, y dudaleniad, a'r rheolyddion caniatâd.
Dilysu
Profwch chwiliad bysellfwrdd, sawl dolen wib, a golygfan 390-picsel heb unrhyw orgyffwrdd na sgrolio llorweddol.
Mater MkDocs
fersiynau mike
Penderfyniad gweithredu
Dewiswch lwybrau stable, latest neu fersiwn benodol yn fwriadol. Ailgropiwch ar ôl symud alias, a hepgorwch ddatganiadau heb gefnogaeth pan fyddai atebion traws-fersiwn yn camarwain defnyddwyr.
Dilysu
Defnyddiwch mike serve i brofi newid fersiwn a chadarnhau datrysiad dyfyniadau y tu mewn i'r fersiwn arfaethedig.
Mater MkDocs
Methiant teclyn neu ddyfyniad
Penderfyniad gweithredu
Gwiriwch fewnoliad YAML, y custom_dir gweithredol, enw bloc etifeddol, allwedd API, CSP, cynnwys map gwefan, ac a yw'r adeiladwaith a ddefnyddir yn cynnwys y gwrthwneud.
Dilysu
Archwiliwch HTML a gynhyrchir a phrofwch yr arteffact cynhyrchu yn hytrach na dibynnu ar ail-lwytho byw yn unig.
Gwiriad ateb a ddyfynnwyd

Profwch ateb yn erbyn y fersiwn gweithredol

Defnyddiwch gwestiwn thema gyda rheol dempled gwiriadwy, yna agorwch y dyfyniad a chadarnhewch ei fod yn cyfateb i'r fersiwn a ddewisodd eich ymwelydd.

Rhestr wirio ymarferol ar gyfer gwerthuso sgwrsfotiau AI dogfennaeth
Gofynnwch i'r canllawiau MkDocs
Sut mae ychwanegu'r teclyn heb dorri chwiliad Material?
Gosodwch theme.custom_dir yn overrides, crëwch overrides/main.html, estynnwch base.html, ac ychwanegwch y llwythwr async yn y bloc scripts ar ôl super(). Mae galw super() yn cadw'r sgriptiau y mae Material yn eu defnyddio ar gyfer chwilio a llywio.

Sgwrs enghreifftiol — nid sgwrs fyw.

Wedi'i bweru gan ChattyBox
Tudalen symudol Material for MkDocs gyda chwiliad a ChattyBox yn weladwy heb i'r rheolyddion orgyffwrdd
Cyfeirnod symudol gwreiddiol: mae chwiliad ar gael o hyd, mae gan y lansiwr darged cyffwrdd y gellir ei ddefnyddio, ac nid yw'r dudalen yn sgrolio'n llorweddol.
Llwybr gosod

Sut i ychwanegu'r teclyn at MkDocs

Ar gyfer Material for MkDocs, gosodwch theme.custom_dir i overrides, estynnwch base.html yn overrides/main.html, a galwch super() cyn sgript asyncronaidd y teclyn. Mae angen cyfeiriadur thema pwrpasol ar wahân a gwrthwneud main.html cyfatebol ar MkDocs plaen.

  1. 1Crëwch brosiect ChattyBox a rhowch URL neu fap gwefan eich safle MkDocs neu Material for MkDocs.
  2. 2Profwch gwestiynau MkDocs go iawn yn y dangosfwrdd a chadarnhewch y dyfyniadau sy'n pwyntio at y tudalennau cywir.
  3. 3Ychwanegwch y gwrthwneud a brofwyd, adeiladwch y safle, a gwiriwch chwilio, llywio, CSP, ac ymddygiad symudol.
overrides/main.html
html
{% extends "base.html" %}

{% block scripts %}
  {{ super() }}
  <script
    id="chattybox-widget"
    src="https://chattybox.ai/widget.js"
    async
    data-api-key="YOUR_API_KEY"
    data-api-url="https://adorable-woodpecker-629.convex.site/chat"
    data-chattybox-widget="true"
  ></script>
{% endblock %}
Cwestiynau cyffredin

Cwestiynau cyffredin

1

Ydy ChattyBox yn gweithio gyda Material for MkDocs?

Ydy. Gall ChattyBox gropian tudalennau cyhoeddus MkDocs a Material for MkDocs, a gellir ei fewnosod fel teclyn gwefan safonol.

2

A oes angen i mi newid fy mhiblinell adeiladu Python?

Nac ydy. Ychwanegwch y pyt teclyn at eich templed gwefan neu wrthwneud thema ar ôl ffurfweddu'r chatbot.

3

A all y bot ateb o ddogfennau fersiwn?

Oes, os yw tudalennau dogfennau fersiwn yn gyhoeddus ac wedi'u cynnwys yn y cropian neu'r map gwefan.

4

A all nodi bylchau yn y ddogfennaeth?

Ar Pro neu Business, mae cwestiynau sydd wedi'u fflagio yn arwyddion hewristig i'w harchwilio am fylchau posibl, nid yn ddiagnosis pendant o'ch cynnwys MkDocs.