01
Arbetar med Material för MkDocs-sidor
Indexera guider, referenssidor och genererad statisk HTML från offentliga MkDocs- eller Material for MkDocs-distributioner utan att byta ut ditt tema.
MkDocs-supportbot
Lägg till en AI-chattbot med källhänvisningar i din MkDocs- och Material-dokumentation
En AI-chattbot för MkDocs och Material for MkDocs-dokumentation. ChattyBox genomsöker din offentliga webbplats, besvarar frågor som “Hur aktiverar jag navigeringsflikar?” från dessa sidor och citerar källan. Ingen Python-indexeringspipeline eller egen RAG att underhålla.
Genomsöker publicerade dokumentsidorKällangivna svarBäddar in med ett skriptIngen dokumentmigrering krävsInget kreditkort krävsDitt innehåll förblir ditt
Registrera dig för att testa vår Free-plan
Utvärderar du ChattyBox för en organisation? Kontakta supporten för att diskutera en provperiod för en större plan.
Fråga ChattyBox
xVar ska jag börja om jag behöver ett tillförlitligt svar från den här webbplatsen?
Börja med att lägga till din webbplats-URL i ChattyBox. Den genomsöker ditt innehåll, svarar utifrån sidorna den hittar och visar besökare källorna bakom varje svar.
iKällor3^
MkDocs vägledning
chattybox.ai
Analys
chattybox.ai
Hem
chattybox.ai
Ställ en fråga...
Drivs av ChattyBox
Byggd för MkDocs-team
Lansera en chattbot med källhänvisningar utan att bygga om din docs-stack
ChattyBox crawlar din befintliga dokumentation, indexerar innehållet för hämtning och bäddar in en chattbot som svarar med dina docs i stället för generiskt modellminne.
Material-överstyrningen bevarar temat JavaScript och lägger till en asynkron widgetladdare.
Vanilla MkDocs använder en separat anpassad temakatalog istället för att anta Material-sökvägar.
Kontrollerna omfattar samspel med sökfunktionen, direktnavigering, dubbla laddare och smala mobilvyer.
Versionsmedvetna val av genomsökningsvägar gör hanteringen av stabila, senaste och äldre mike-rutter avsiktlig.
1Arbetsflödessteg
Genomsök den distribuerade MkDocs-webbplatskartan eller de stabila och versionsbaserade sökvägarna som du avsiktligt stödjer.
2Arbetsflödessteg
Testa frågor om produkten, Python och API:et och öppna varje källhänvisning före installationen.
3Arbetsflödessteg
För Material, konfigurera theme.custom_dir och utöka base.html från overrides/main.html samtidigt som skriptblocket bevaras med super().
4Arbetsflödessteg
Verifiera inbyggd sökning, omedelbar navigering, mobilkontroller, CSP och varje publicerad mike-version.
Lansering i tre steg
Klistra in din MkDocs URL, testa citerade svar och installera sedan widgeten.
MkDocs-specifikt arbetsflöde
Konversationsstöd för statiska Python-dokumentationssajter
MkDocs-team vill vanligtvis ha snabba statiska konstruktioner, tydlig navigering och läsbart tekniskt innehåll. ChattyBox behåller det arbetsflödet intakt samtidigt som en källciterad assistent läggs till ovanpå den publicerade webbplatsen.
Beslutsväg
Använd dessa kontrollpunkter för att bestämma om ChattyBox ska sitta bredvid din dokumentplattform, ersätta en separat assistent eller hålla sig isolerad för testning.
02
Hantera versionsdokumentation medvetet
Peka ChattyBox på versionsvägarna du vill att användarna ska fråga om och testa sedan om svaren citerar de avsedda stabila, senaste eller äldre dokumenten.
03
Inget Python-indexeringsjobb att underhålla
Eftersom ChattyBox genomsöker den offentliga webbplatsen, behöver team inte lägga till vektorindexering till sin MkDocs-byggledning eller CI-skript.
04
Förbättra dokument från verkliga frågor
Använd obesvarade frågor för att identifiera saknade exempel, oklara installationssteg eller föråldrade felsökningssidor på din MkDocs-webbplats.
Verifierat redaktionellt underlag
Testade installationsvägar för Material och vanilla MkDocs
Material for MkDocs och det inbyggda MkDocs-temat stöder båda mallarv, men de bör använda separata anpassade kataloger. Material-sökvägen nedan bevarar sitt skriptblock med super(), lägger till en asynkronladdare och överlever omedelbar navigering utan att ersätta sökbeteende.
- Teknisk författare
- ChattyBox dokumentationsteam
- Teknisk granskare
- ChattyBox Engineering
- Senast uppdaterad
- Information kontrollerad
- MkDocs, Material for MkDocs och mike
Kontrollera mallblocken och omedelbar navigering efter temauppgraderingar och genomsök igen när ett mike-alias flyttas.
| MkDocs-aspekt | Beslut om genomförande | Kontroll |
|---|---|---|
MkDocs-aspekt Åsidosättning i Material | Beslut om genomförande Ställ in theme.name på material och theme.custom_dir på overrides. Utöka base.html, åsidosätt scripts-blocket, anropa super() och lägg sedan till widgetskriptet. | Kontroll Bygg och betjäna webbplatsen och bekräfta sedan att Material-sökning och navigering fortfarande fungerar. |
MkDocs-aspekt Vanilj MkDocs | Beslut om genomförande Använd theme.name: mkdocs med en separat custom_theme-katalog. Lägg till motsvarande custom_theme/main.html åsidosättande istället för att kopiera Material mallar. | Kontroll Kör mkdocs serve och verifiera sökningen, nästa och föregående länkar och widgeten på mer än en sida. |
MkDocs-aspekt Asynkron laddning och dubbletter | Beslut om genomförande Behåll en laddare i det ärvda skriptblocket, ge det ett stabilt ID och lägg inte till samma kodavsnitt genom extra_javascript eller en annan del. | Kontroll Bekräfta efter fullständiga sidladdningar och Materials direktövergångar att document.querySelectorAll("#chattybox-widget").length är 1. |
MkDocs-aspekt Innehållssäkerhetspolicy | Beslut om genomförande Tillåt chattybox.ai i script-src, det konfigurerade API-ursprunget i connect-src, fonts.googleapis.com i style-src och fonts.gstatic.com i font-src. Den aktuella widgeten injicerar sin komponent-CSS, så en strikt style-src behöver även 'unsafe-inline' tills en nonce-medveten eller extern stilmallsbyggnad är tillgänglig. | Kontroll Kontrollera webbläsarkonsolen och nätverkspanelen efter blockerade skript-, stil-, typsnitts-, hämtnings- eller WebSocket-förfrågningar. |
MkDocs-aspekt Sök, direktnavigering och mobil | Beslut om genomförande Bevara temats skript med super() och håll startknappen fri från sökdialogen, sidopanelen, sidnumreringen och samtyckeskontrollerna. | Kontroll Testa tangentbordssökning, flera direktlänkar och en 390-pixel visningsport utan överlappning eller horisontell rullning. |
MkDocs-aspekt mike versioner | Beslut om genomförande Välj stabila, senaste eller explicita versionsvägar medvetet. Genomsök om efter att ha flyttat ett alias och uteslut utgåvor som inte stöds när svar i flera versioner skulle vilseleda användare. | Kontroll Använd mike serve för att testa versionsbyte och bekräfta att hänvisningar löser sig i den avsedda versionen. |
MkDocs-aspekt Widget- eller citeringsfel | Beslut om genomförande Kontrollera YAML-indrag, den aktiva custom_dir, ärvt blocknamn, API-nyckel, CSP, innehåll i webbplatskartan och om den distribuerade versionen innehåller åsidosättningen. | Kontroll Inspektera genererad HTML och testa produktionsartefakten istället för att bara förlita sig på live-omladdning. |
Kontroll av citerade svar
Testa ett svar mot den aktiva versionen
Använd en temafråga med en verifierbar mallregel, öppna sedan citatet och bekräfta att det matchar den version som din besökare valde.
Fråga MkDocs-guiderna
xHur lägger jag till widgeten utan att bryta Material-sökningen?
Ställ in theme.custom_dir på overrides, skapa overrides/main.html, utöka base.html och lägg till den asynkrona laddaren i scripts-blocket efter super(). Anropet till super() bevarar skripten som Material använder för sökning och navigering.
Ställ en fråga...
Drivs av ChattyBox
Primärkällor och reproducerbart underlag
Material for MkDocs anpassningOfficiell vägledning om custom_dir, mallarv och åsidosättning av block.Material omedelbar navigeringOfficiellt beteende för dokumentersättning utan att ladda om en hel sida.MkDocs temaanpassningOfficiell anpassad temakatalog, basmall och super()-vägledning för vanilj MkDocs.mike versionsdokumentationVersionsdistribution, alias, standardversion och lokal testning av flera versioner.Körbara MkDocs-exempelExempel för Material och vanilla MkDocs med temaöverskrivningar, testsidor och widgetens aktuella attribut.
Installationsväg
Hur man lägger till widgeten till MkDocs
För Material for MkDocs, ställ in theme.custom_dir på overrides, utöka base.html i overrides/main.html och anropa super() före det asynkrona widgetskriptet. Vanilla MkDocs behöver en egen anpassad temakatalog och en motsvarande main.html-överstyrning.
- 1Skapa ett ChattyBox-projekt och ange din MkDocs- eller Material for MkDocs-webbplats-URL eller webbplatskarta.
- 2Testa riktiga MkDocs-frågor i instrumentpanelen och bekräfta att citaterna pekar till rätt sidor.
- 3Lägg till den testade överstyrningen, bygg webbplatsen och verifiera sök, navigering, CSP och mobilt beteende.
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 %}Utforska härnäst
Fler sätt att använda ChattyBox
01AI chatbot för dokumentationSe den källciterade dokumentationen för chatbot-arbetsflödet som gäller på alla plattformar.02API dokumentation chatbotSvara på frågor om slutpunkt, parameter och autentisering från Python och API referensdokument.03Docusaurus AI chatbotJämför samma jordade arbetsflöde för Docusaurus-dokumentationswebbplatser.04Bläddra igenom alla plattformsguiderHitta installationsguider för Docusaurus, VitePress, Starlight, Nextra, Mintlify, ReadMe och fler dokumentplattformar.
Vanliga frågor
Vanliga frågor
1
Fungerar ChattyBox med Material for MkDocs?
Ja. ChattyBox kan crawla offentliga MkDocs- och Material for MkDocs-sidor och bäddas in som en standardwidget för webbplatser.
2
Behöver jag ändra min Python-buildpipeline?
Nej. Lägg till widgetsnutten i din webbplatsmall eller theme override efter att du har konfigurerat chattboten.
3
Kan boten svara från versionerade docs?
Ja, om versionerade docs-sidor är offentliga och ingår i crawlen eller sitemapen.
4
Kan den identifiera dokumentationsluckor?
Ja. ChattyBox Analytics hjälper till att visa frågor som ditt MkDocs-innehåll ännu inte besvarar tydligt.
Registrera dig för att testa vår Free-plan
Utvärderar du ChattyBox för en organisation? Kontakta supporten för att diskutera en provperiod för en större plan.