01
Töötab materjaliga MkDocsi lehtede jaoks
Juhendid, viitelehed ja loodud staatiline HTML avalikest MkDocsi või MkDocsi juurutustest ilma teie teemat asendamata.
MkDocs Tugibot
Lisage allikaviidetega tehisintellekti vestlusbot oma MkDocsi ja Materiali dokumentatsioonile
Tehisintellekti vestlusrobot MkDocsi ja Material for MkDocs dokumentatsioonile. ChattyBox roomab teie avalikku saiti, vastab küsimustele nagu „Kuidas navigeerimiskaarte lubada?“ nendelt lehtedelt ja viitab allikale. Pythoni indekseerimiskonveierit ega kohandatud RAG-i pole vaja hallata.
Roomab avaldatud dokumentide lehtedelAllikale viidatud vastusedManustatakse ühe skriptigaDokumentide migreerimine pole vajalikKrediitkaarti pole vajaTeie sisu jääb teile
Registreeru, et testida meie Free-paketti
Kas hindad ChattyBoxi organisatsiooni jaoks? Võta ühendust toega suurema paketi prooviperioodi arutamiseks.
Küsi ChattyBoxilt
xKust peaksin alustama, kui vajan sellelt saidilt usaldusväärset vastust?
Alustage oma veebisaidi URL-i lisamisest ChattyBoxi. See kraabib teie sisu, vastab leitud lehtede põhjal ja näitab külastajatele iga vastuse allikaid.
iAllikad3^
MkDocs juhend
chattybox.ai
Analüütika
chattybox.ai
Avaleht
chattybox.ai
Esita küsimus...
Toetab ChattyBox
Ehitatud MkDocs meeskonnad jaoks
Käivitage allikaviidetega vestlusbot ilma saidi tehnilist pinu ümber ehitamata
ChattyBox roomab teie olemasolevat veebisaiti, dokumentatsiooni, abikeskust, CMS-i või teadmistebaasi ning manustab seejärel vestlusroboti, mis vastab teie enda avaldatud sisu, mitte mudeli üldise mälu põhjal.
Materiali ülekirjutus säilitab teema JavaScripti ja lisab ühe asünkroonse vidinalaaduri.
Tavaline MkDocs kasutab Materiali teede eeldamise asemel eraldi kohandatud teema kataloogi.
Kontrollid hõlmavad otsingu koostoimimist, kiirnavigeerimist, laaduri duplikaate ja kitsaid mobiilivaatealasid.
Versiooniteadlik indekseerimisvalik hoiab mike'i stabiilsed, uusimad ja pärandteed teadlikult valituna.
1Töövoo samm
Indekseerige juurutatud MkDocsi saidikaart või stabiilsed ja versioonitud teed, mida te teadlikult toetate.
2Töövoo samm
Testige toote-, Pythoni- ja API-küsimusi ning avage enne paigaldamist iga viide.
3Töövoo samm
Seadistage Materiali jaoks theme.custom_dir ja laiendage faili base.html failist overrides/main.html, säilitades ploki scripts funktsiooniga super().
4Töövoo samm
Kontrollige sisseehitatud otsingut, kiirnavigeerimist, mobiilseid juhtelemente, CSP-d ja iga avaldatud mike versiooni.
Kolmeastmeline käivitamine
Kleepige oma MkDocs URL, testige viidatud vastuseid ja installige seejärel vidin.
MkDocsi-spetsiifiline töövoog
Vestlustugi staatiliste Pythoni dokumentatsioonisaitide jaoks
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.
Otsuste tee
Kasutage neid kontrollpunkte, et otsustada, kas ChattyBox peaks asuma teie dokumentide platvormi kõrval, asendama eraldi assistendi või jääma testimiseks isoleerituks.
02
Käsitlege versioonidega dokumentatsiooni teadlikult
Osutage ChattyBox versiooniteedele, mille kohta soovite kasutajatelt küsida, ja seejärel testige, kas vastused viitavad kavandatud stabiilsetele, uusimatele või päranddokumentidele.
03
Pythoni indekseerimistööd pole vaja säilitada
Kuna ChattyBox roomab avalikul saidil, ei pea meeskonnad oma MkDocsi ehituskonveierile ega CI-skriptidele vektorindeksit lisama.
04
Parandage dokumente tõelistest küsimustest
Kasutage vastamata küsimusi oma MkDocsi saidi puuduvate näidete, ebaselgete installietappide või aegunud tõrkeotsingu lehtede tuvastamiseks.
Kontrollitud toimetuslikud tõendid
Testitud Materiali ja tavalise MkDocsi paigaldusteed
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.
- Tehniline autor
- ChattyBoxi dokumentatsioonitiim
- Tehniline ülevaataja
- ChattyBoxi inseneritiim
- Viimati uuendatud
- Teave kontrollitud
- MkDocs, Material for MkDocs ja mike
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 Järgake ja serveerige 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-tuge pakkuv või väline laaditabel. | 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. |
Viidetega vastuse kontroll
Testige vastust aktiivse versiooni suhtes
Kasutage kontrollitava mallireegliga teemaküsimust, avage seejärel viide ja veenduge, et see vastaks külastaja valitud versioonile.
Küsi MkDocsi juhenditelt
xKuidas lisada vidin Materiali otsingut rikkumata?
Määrake theme.custom_dir väärtuseks overrides, looge overrides/main.html, laiendage faili base.html ja lisage asünkroonne laadur plokis scripts pärast funktsiooni super(). Funktsiooni super() kutsumine säilitab skriptid, mida Material kasutab otsinguks ja navigeerimiseks.
Esita küsimus...
Toetab ChattyBox
Algallikad ja korratavad tõendid
Material for MkDocs kohandamineAmetlikud custom_dir, mallipäriluse ja plokkide ülekirjutamise juhised.Materiali kiirnavigeerimineDokumendi ilma lehe täieliku taaslaadimiseta asendamise ametlik käitumine.MkDocsi teema kohandamineAmetlikud kohandatud teema kataloogi, põhimalli ja super() juhised tavalisele MkDocsile.mike'i versioonitud dokumentatsioonVersioonide juurutamine, aliased, vaikeversioon ja kohalik mitme versiooni testimine.Käivitatavad MkDocsi näitedMateriali ja vanilla MkDocsi näited koos teema ülekirjutuste, testlehtede ja vidina praeguste atribuutidega.
Paigaldustee
Kuidas vidinat MkDocsi lisada
Material 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.
- 1Looge ChattyBoxi projekt ja sisestage oma MkDocsi või Material for MkDocs saidi URL või saidikaart.
- 2Testige armatuurlaual tõelisi MkDocsi küsimusi ja kinnitage, et tsitaadid viitavad õigetele lehtedele.
- 3Lisage testitud ülekirjutus, koostage sait ja kontrollige otsingut, navigeerimist, CSP-d ja mobiilikäitumist.
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 %}Uuri järgmiseks
Rohkem viise ChattyBoxi kasutamiseks
01AI vestlusbot dokumenteerimiseksVaadake allikale viidatud dokumentatsiooni vestlusroti töövoogu, mis kehtib kõikidel platvormidel.02API dokumentatsiooni vestlusbotVastake Pythoni ja API viitedokumentide lõpp-punkti, parameetri ja autentimise küsimustele.03Docusaurus AI vestlusbotVõrrelge sama maandatud töövoogu Docusauruse dokumentatsioonisaitide jaoks.04Sirvige kõiki platvormi juhendeidOtsige Docusauruse, VitePressi, Starlighti, Nextra, Mintlify, ReadMe ja muude dokumentide platvormide seadistusjuhendeid.
KKK
Levinud küsimused
1
Kas ChattyBox töötab koos Material for MkDocs-ga?
Jah. ChattyBox saab roomata avalikel MkDocs ja Material for MkDocs lehtedel ja manustada standardse veebisaidi vidinana.
2
Kas ma pean oma Pythoni ehituskonveieri muutma?
Ei. Lisage vidina koodilõik oma saidimalli või teema alistamisse pärast vestlusroti seadistamist.
3
Kas robot saab vastata versioonidega dokumentidest?
Jah, kui versioonidega dokumentide lehed on avalikud ja sisalduvad roomamis- või saidiplaanis.
4
Kas see suudab tuvastada dokumentatsioonilünki?
Jah. ChattyBox analüütika aitab paljastada küsimusi, millele teie MkDocs sisu ei vasta veel selgelt.
Registreeru, et testida meie Free-paketti
Kas hindad ChattyBoxi organisatsiooni jaoks? Võta ühendust toega suurema paketi prooviperioodi arutamiseks.