Töötab Material for MkDocsi lehtedega
Indekseerige avalike MkDocsi või Material for MkDocsi saitide juhendid, teatmelehed ja genereeritud staatiline HTML, ilma et peaksite oma teemat asendama.
Tehisintellekti vestlusbot MkDocsi ja Material for MkDocsi dokumentatsioonile. ChattyBox roomab teie avalikku saiti ning vastused võivad sisaldada linke leitud lehtedele. Kontrollige vastuste ja viidete täpsust. Pythoni indekseerimiskonveierit ega kohandatud RAG-i pole vaja hallata.
ChattyBox roomab teie olemasolevat veebisaiti, dokumentatsiooni, abikeskust, CMS-i või teadmistebaasi. Leitud sisu võib suunata vestlusroboti vastuseid; kontrollige vastuste ja viidete täpsust.
Indekseerige juurutatud MkDocsi saidikaart või stabiilsed ja versioonitud teed, mida te teadlikult toetate.
Testige toote-, Pythoni- ja API-küsimusi ning avage enne paigaldamist iga viide.
Seadistage Materiali jaoks theme.custom_dir ja laiendage faili base.html failist overrides/main.html, säilitades ploki scripts funktsiooniga super().
Kontrollige sisseehitatud otsingut, kiirnavigeerimist, mobiilseid juhtelemente, CSP-d ja iga avaldatud mike versiooni.
Kolmeastmeline käivitamine
MkDocsi meeskonnad soovivad tavaliselt kiireid staatilisi koostamisi, selget navigeerimist ja loetavat tehnilist sisu. ChattyBox hoiab selle töövoo puutumatuna, lisades samal ajal avaldatud saidile allikale viidatud assistendi.
Kasutage neid kontrollpunkte, et otsustada, kas ChattyBox peaks asuma teie dokumentide platvormi kõrval, asendama eraldi assistendi või jääma testimiseks isoleerituks.
Indekseerige avalike MkDocsi või Material for MkDocsi saitide juhendid, teatmelehed ja genereeritud staatiline HTML, ilma et peaksite oma teemat asendama.
Suunake ChattyBox versiooniteedele, mille kohta kasutajad võivad küsida, ja testige seejärel, kas vastused viitavad soovitud stabiilsele, uusimale või vanemale dokumentatsioonile.
Kuna ChattyBox roomab avalikul saidil, ei pea meeskonnad oma MkDocsi ehituskonveierile ega CI-skriptidele vektorindeksit lisama.
Pro või Businessi paketis vaadake märgistatud küsimused üle kui heuristilised märguanded võimalike puuduvate näidete, ebaselgete installietappide või aegunud tõrkeotsingulehtede kohta.
Material for MkDocs ja MkDocsi sisseehitatud teema toetavad mõlemad mallipärilust, kuid peaksid kasutama eraldi kohandatud katalooge. Alltoodud Materiali tee säilitab funktsiooniga super() oma ploki scripts, lisab ühe asünkroonse laaduri ja talub kiirnavigeerimist otsingu käitumist asendamata.
Kontrollige pärast teema uuendusi malliplokke ja kiirnavigeerimise käitumist uuesti ning indekseerige iga mike'i aliase teisaldamise järel uuesti.
| MkDocsi küsimus | Teostusotsus | Kontrollimine |
|---|---|---|
MkDocsi küsimus Materiali ülekirjutus | Teostusotsus Määrake theme.name väärtuseks material ja theme.custom_dir väärtuseks overrides. Laiendage faili base.html, kirjutage scripts üle, kutsuge super() ning lisage seejärel vidina skript. | Kontrollimine Koostage ja käivitage sait ning veenduge seejärel, et Materiali otsing ja navigeerimine endiselt töötaksid. |
MkDocsi küsimus Tavaline MkDocs | Teostusotsus Kasutage theme.name: mkdocs koos eraldi custom_theme kataloogiga. Materiali mallide kopeerimise asemel lisage samaväärne custom_theme/main.html ülekirjutus. | Kontrollimine Käivitage mkdocs serve ning kontrollige otsingut, järgmise ja eelmise lehe linke ning vidinat rohkem kui ühel lehel. |
MkDocsi küsimus Asünkroonne laadimine ja duplikaadid | Teostusotsus Hoidke päritud plokis scripts üks laadur, andke sellele püsiv ID ja ärge lisage sama koodilõiku extra_javascript ega mõne teise osamalli kaudu. | Kontrollimine Veenduge pärast täielikke laadimisi ja Materiali kiirüleminekuid, et document.querySelectorAll("#chattybox-widget").length on 1. |
MkDocsi küsimus Sisuturbepoliitika | Teostusotsus Lubage chattybox.ai direktiivis script-src, seadistatud API päritolu direktiivis connect-src, fonts.googleapis.com direktiivis style-src ja fonts.gstatic.com direktiivis font-src. Praegune vidin sisestab oma komponendi CSS-i, seega vajab range style-src ka 'unsafe-inline'-i, kuni on saadaval nonce'i toetav või välist laadilehte kasutav järk. | Kontrollimine Kontrollige brauseri konsoolist ja paneelilt Network blokeeritud skripti-, stiili-, font-, fetch- või WebSocket-päringuid. |
MkDocsi küsimus Otsing, kiirnavigeerimine ja mobiilivaade | Teostusotsus Säilitage teema skriptid funktsiooniga super() ning hoidke käivitusnupp eemal otsingudialoogist, külgpaneelist, lehekülgjaotusest ja nõusoleku juhtelementidest. | Kontrollimine Testige klaviatuuriotsingut, mitut kiirlinki ja 390-pikslist vaateala ilma kattumise või horisontaalse kerimiseta. |
MkDocsi küsimus mike'i versioonid | Teostusotsus Valige stabiilse, uusima või konkreetse versiooni teed teadlikult. Indekseerige pärast aliase teisaldamist uuesti ja välistage toetamata väljalasked, kui versioonideülesed vastused eksitaksid kasutajaid. | Kontrollimine Kasutage versioonivahetuse testimiseks käsku mike serve ja veenduge, et viited avaneksid soovitud versioonis. |
MkDocsi küsimus Vidina või viite tõrge | Teostusotsus Kontrollige YAML-i taanet, aktiivset custom_dir kataloogi, päritud ploki nime, API-võtit, CSP-d, saidikaardi sisu ja seda, kas juurutatud järk sisaldab ülekirjutust. | Kontrollimine Kontrollige loodud HTML-i ja testige tootmisartefakti, selle asemel et toetuda ainult reaalajas taaslaadimisele. |
Kasutage kontrollitava mallireegliga teemaküsimust, avage seejärel viide ja veenduge, et see vastaks külastaja valitud versioonile.
Praktiline kontrollnimekiri dokumentatsiooni AI-vestlusrobotite hindamiseksMaterial for MkDocs jaoks määrage theme.custom_dir väärtuseks overrides, laiendage base.html failis overrides/main.html ja kutsuge super() enne asünkroonset vidinaskripti. Tavaline MkDocs vajab oma kohandatud teema kataloogi ja samaväärset main.html ülekirjutust.
{% 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 %}Jah. ChattyBox saab roomata avalikel MkDocs ja Material for MkDocs lehtedel ja manustada standardse veebisaidi vidinana.
Ei. Pärast vestlusroboti seadistamist lisage vidina koodilõik saidimalli või teema ülekirjutusse.
Jah, kui dokumentatsiooni versioonitud lehed on avalikud ja kaasatud roomamisse või saidikaarti.
Pro või Businessi paketis on märgistatud küsimused heuristilised märguanded, mida võimalike lünkade leidmiseks uurida, mitte lõplikud diagnoosid teie MkDocsi sisu kohta.