MkDocs-Support-Bot

MkDocs-KI-Chatbot für MkDocs-Dokumentation

Ein KI-Chatbot für MkDocs- und Material-for-MkDocs-Dokumentation. ChattyBox crawlt Ihre öffentliche Website, beantwortet Fragen wie „Wie aktiviere ich Navigationsregisterkarten?“ aus diesen Seiten und nennt die Quelle. Keine Python-Indexierungspipeline und kein benutzerdefiniertes RAG, das gepflegt werden muss.

Crawlt veröffentlichte Dokumentseiten

Quellenzitierte Antworten

Einbettung mit einem Skript

Keine Dokumentenmigration erforderlich

Erstellen Sie kostenlos einen MkDocs KI-Chatbot Einrichtungsanleitung lesen

Keine Kreditkarte erforderlichIhre Inhalte bleiben Ihre Inhalte

ChattyBox fragen

Wo sollte ich anfangen, wenn ich eine verlässliche Antwort von dieser Website brauche?

Fügen Sie zunächst Ihre Website-URL zu ChattyBox hinzu. Es crawlt Ihre Inhalte, beantwortet Fragen anhand der gefundenen Seiten und zeigt Besuchern die Quellen hinter jeder Antwort.

iQuellen3^

MkDocs Leitfaden

chattybox.ai

Analysen

chattybox.ai

Startseite

chattybox.ai

Eine Frage stellen...

Bereitgestellt von ChattyBox

Entwickelt für MkDocs-Teams

Starten Sie einen Chatbot mit Quellenangaben, ohne Ihren Docs-Stack neu aufzubauen

ChattyBox crawlt Ihre bestehende Dokumentation, indexiert die Inhalte für den Abruf und bettet einen Chatbot ein, der mit Ihren Docs antwortet statt mit generischem Modellgedächtnis.

Die Material-Überschreibung behält das Theme-JavaScript bei und fügt einen asynchronen Widget-Loader hinzu.

Standard-MkDocs verwendet ein separates benutzerdefiniertes Theme-Verzeichnis, statt Material-Pfade vorauszusetzen.

Die Prüfungen decken das Zusammenspiel mit der Suche, Sofortnavigation, doppelte Loader und schmale mobile Ansichtsbereiche ab.

Eine versionsbewusste Crawl-Auswahl sorgt für eine gezielte Behandlung stabiler, neuester und älterer mike-Routen.

Workflow-Schritt

Crawlen Sie die bereitgestellte MkDocs-Sitemap oder die stabilen und versionierten Pfade, die Sie bewusst unterstützen.

Workflow-Schritt

Testen Sie Produkt-, Python- und API-Fragen und öffnen Sie vor der Installation jede Quellenangabe.

Workflow-Schritt

Konfigurieren Sie für Material theme.custom_dir und erweitern Sie base.html aus overrides/main.html, wobei Sie den scripts-Block mit super() beibehalten.

Workflow-Schritt

Prüfen Sie die integrierte Suche, Sofortnavigation, mobile Bedienelemente, CSP und jede veröffentlichte mike-Version.

Dreistufiger Start

Fügen Sie Ihre MkDocs-URL ein, testen Sie die zitierten Antworten und installieren Sie dann das Widget.

Erstellen Sie kostenlos einen MkDocs KI-Chatbot

MkDocs-spezifischer Workflow

Konversationsunterstützung für statische Python-Dokumentationsseiten

MkDocs-Teams wünschen sich in der Regel schnelle statische Builds, klare Navigation und lesbare technische Inhalte. ChattyBox hält diesen Arbeitsablauf aufrecht und fügt der veröffentlichten Site einen Assistenten mit Quellenangabe hinzu.

Entscheidungsweg

Verwenden Sie diese Prüfpunkte, um zu entscheiden, ob ChattyBox neben Ihrer Dokumentenplattform stehen, einen separaten Assistenten ersetzen oder zum Testen isoliert bleiben soll.

Funktioniert mit Material für MkDocs-Seiten

Indexhandbücher, Referenzseiten und generiertes statisches HTML aus öffentlichen MkDocs- oder Material für MkDocs-Bereitstellungen, ohne Ihr Theme zu ersetzen.

Gehen Sie bewusst mit versionierter Dokumentation um

Zeigen Sie mit ChattyBox auf die Versionspfade, nach denen Benutzer fragen sollen, und testen Sie dann, ob in den Antworten die beabsichtigten stabilen, neuesten oder älteren Dokumente zitiert werden.

Es muss kein Python-Indizierungsjob verwaltet werden

Da ChattyBox die öffentliche Website crawlt, müssen Teams keine Vektorindizierung zu ihrer MkDocs-Build-Pipeline oder ihren CI-Skripten hinzufügen.

Verbessern Sie Dokumente anhand echter Fragen

Verwenden Sie unbeantwortete Fragen, um fehlende Beispiele, unklare Installationsschritte oder veraltete Fehlerbehebungsseiten auf Ihrer MkDocs-Site zu identifizieren.

Geprüfte redaktionelle Nachweise

Getestete Installationswege für Material und Standard-MkDocs

Material for MkDocs und das integrierte MkDocs-Theme unterstützen beide Vorlagenvererbung, sollten jedoch getrennte benutzerdefinierte Verzeichnisse verwenden. Der folgende Material-Pfad behält seinen scripts-Block mit super() bei, fügt einen asynchronen Loader hinzu und übersteht die Sofortnavigation, ohne das Suchverhalten zu ersetzen.

Technische Autorin oder technischer Autor: ChattyBox-Dokumentationsteam
Technische Prüfung: ChattyBox-Entwicklung
Zuletzt aktualisiert: 2026-07-09
Informationen geprüft: MkDocs, Material for MkDocs und mike

Prüfen Sie nach Theme-Upgrades die Vorlagenblöcke und das Verhalten der Sofortnavigation erneut und crawlen Sie neu, sobald ein mike-Alias verschoben wird.

custom_dir-Konfiguration von Material for MkDocs und Überschreibung der Hauptvorlage unter Beibehaltung der Theme-Skripte — Ursprüngliche Installationsreferenz: theme.custom_dir wählt die Überschreibung aus und super() behält die Such- und Navigationsskripte von Material unverändert bei.

Installationsentscheidungen für Material und Standard-MkDocs mit End-to-End-Prüfungen.
MkDocs-Aspekt	Implementierungsentscheidung	Überprüfung
Material-Überschreibung	Setzen Sie theme.name auf material und theme.custom_dir auf overrides. Erweitern Sie base.html, überschreiben Sie scripts, rufen Sie super() auf und hängen Sie anschließend das Widget-Skript an.	Erstellen und starten Sie die Website und bestätigen Sie anschließend, dass Suche und Navigation von Material weiterhin funktionieren.
Standard-MkDocs	Verwenden Sie theme.name: mkdocs mit einem separaten custom_theme-Verzeichnis. Fügen Sie die entsprechende Überschreibung custom_theme/main.html hinzu, statt Material-Vorlagen zu kopieren.	Führen Sie mkdocs serve aus und prüfen Sie die Suche, Links zur nächsten und vorherigen Seite sowie das Widget auf mehreren Seiten.
Asynchrones Laden und Duplikate	Behalten Sie einen Loader im geerbten scripts-Block, geben Sie ihm eine stabile ID und fügen Sie dasselbe Snippet nicht über extra_javascript oder eine andere Teilvorlage hinzu.	Bestätigen Sie nach vollständigem Laden und Sofortübergängen von Material, dass document.querySelectorAll("#chattybox-widget").length den Wert 1 hat.
Content Security Policy	Erlauben Sie chattybox.ai in script-src, den konfigurierten API-Ursprung in connect-src, fonts.googleapis.com in style-src und fonts.gstatic.com in font-src. Das aktuelle Widget fügt sein Komponenten-CSS ein, daher benötigt eine strenge style-src-Richtlinie zusätzlich 'unsafe-inline', bis ein Nonce-basierter oder externer Stylesheet-Build verfügbar ist.	Prüfen Sie die Browserkonsole und den Network-Bereich auf blockierte Skript-, Stil-, Schrift-, Fetch- oder WebSocket-Anfragen.
Suche, Sofortnavigation und Mobilgeräte	Behalten Sie Theme-Skripte mit super() bei und halten Sie den Starter von Suchdialog, Navigationsleiste, Paginierung und Einwilligungssteuerelementen frei.	Testen Sie die Tastatursuche, mehrere Sofortlinks und einen 390 Pixel breiten Ansichtsbereich ohne Überlappung oder horizontales Scrollen.
mike-Versionen	Wählen Sie stabile, neueste oder explizite Versionspfade bewusst aus. Crawlen Sie nach dem Verschieben eines Alias erneut und schließen Sie nicht unterstützte Versionen aus, wenn versionsübergreifende Antworten Nutzende irreführen würden.	Verwenden Sie mike serve, um den Versionswechsel zu testen und zu bestätigen, dass Quellenangaben innerhalb der vorgesehenen Version aufgelöst werden.
Fehler bei Widget oder Quellenangabe	Prüfen Sie YAML-Einrückung, aktives custom_dir, Namen des geerbten Blocks, API-Schlüssel, CSP, Sitemap-Inhalt und ob der bereitgestellte Build die Überschreibung enthält.	Prüfen Sie das generierte HTML und testen Sie das Produktionsartefakt, statt sich nur auf Live Reload zu verlassen.

Prüfung einer Antwort mit Quellenangaben

Eine Antwort mit der aktiven Version testen

Verwenden Sie eine Theme-Frage mit einer überprüfbaren Vorlagenregel, öffnen Sie anschließend die Quellenangabe und bestätigen Sie, dass sie der von Ihrem Besucher gewählten Version entspricht.

Die MkDocs-Leitfäden fragen

Wie füge ich das Widget hinzu, ohne die Material-Suche zu beeinträchtigen?

Setzen Sie theme.custom_dir auf overrides, erstellen Sie overrides/main.html, erweitern Sie base.html und fügen Sie den asynchronen Loader im scripts-Block nach super() hinzu. Der Aufruf von super() behält die Skripte bei, die Material für Suche und Navigation verwendet.

iQuellen2^

Material: Anpassung

squidfunk.github.io/mkdocs-material

MkDocs: Theme anpassen

mkdocs.org/user-guide

Eine Frage stellen...

Bereitgestellt von ChattyBox

Ursprüngliche Mobilreferenz: Die Suche bleibt verfügbar, der Starter besitzt eine gut nutzbare Berührungsfläche und die Seite scrollt nicht horizontal.

Primärquellen und reproduzierbare Nachweise

Anpassung von Material for MkDocsOffizielle Anleitung zu custom_dir, Vorlagenvererbung und Blocküberschreibungen.Sofortnavigation von MaterialOffizielles Verhalten beim Ersetzen von Dokumenten ohne vollständiges Neuladen der Seite.Anpassung des MkDocs-ThemesOffizielle Anleitung zu benutzerdefiniertem Theme-Verzeichnis, Basisvorlage und super() für Standard-MkDocs.Versionierte Dokumentation mit mikeVersionsbereitstellung, Aliasse, Standardversion und lokale Tests mehrerer Versionen.Reproduzierbare MkDocs-BeispieleGetrennte Material- und Standardprojekte mit getesteten Vorlagenüberschreibungen.

Installationspfad

So fügen Sie das Widget zu MkDocs hinzu

Legen Sie für Material for MkDocs theme.custom_dir auf overrides fest, erweitern Sie in overrides/main.html die Datei base.html und rufen Sie super() vor dem asynchronen Widget-Skript auf. Standard-MkDocs benötigt ein eigenes benutzerdefiniertes Theme-Verzeichnis und eine entsprechende main.html-Überschreibung.

1Erstellen Sie ein ChattyBox-Projekt und geben Sie die URL oder Sitemap Ihrer MkDocs- oder Material-for-MkDocs-Website ein.
2Testen Sie echte MkDocs-Fragen im Dashboard und prüfen Sie, ob Zitate auf die richtigen Seiten verweisen.
3Fügen Sie die getestete Überschreibung hinzu, erstellen Sie die Website und prüfen Sie Suche, Navigation, CSP und das Verhalten auf Mobilgeräten.

Erstellen Sie kostenlos einen MkDocs KI-Chatbot

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 %}

Als Nächstes ansehen

Weitere Möglichkeiten, ChattyBox zu nutzen

Alle Lösungen ansehen

KI-Chatbot für Dokumentation

Sehen Sie den dokumentationsorientierten Chatbot-Workflow mit Quellenangaben, der plattformübergreifend funktioniert.

Öffnen

API-Dokumentations-Chatbot

Beantworten Sie Endpoint-, Parameter- und Authentifizierungsfragen aus Python- und API-Referenzdocs.

Öffnen

Docusaurus KI-Chatbot

Vergleichen Sie denselben quellengestützten Workflow für Docusaurus-Dokumentationssites.

Öffnen

Alle Plattform-Guides anzeigen

Finden Sie Setup-Guides für Docusaurus, VitePress, Starlight, Nextra, Mintlify, ReadMe und weitere Docs-Plattformen.

Öffnen

Häufige Fragen

Funktioniert ChattyBox mit Material for MkDocs?

Ja. ChattyBox kann öffentliche MkDocs- und Material for MkDocs-Seiten crawlen und sich als Standard-Website-Widget einbetten lassen.

Muss ich meine Python-Build-Pipeline ändern?

Nein. Fügen Sie das Widget-Snippet nach der Konfiguration des Chatbots zu Ihrem Site-Template oder Theme-Override hinzu.

Kann der Bot aus versionierten Docs antworten?

Ja, wenn die versionierten Docs-Seiten öffentlich sind und im Crawl oder in der Sitemap enthalten sind.

Kann es Dokumentationslücken erkennen?

Ja. ChattyBox Analytics helfen dabei, Fragen sichtbar zu machen, die Ihre MkDocs-Inhalte noch nicht klar beantworten.

Kostenlos starten

Keine Kreditkarte erforderlich. Ihre Inhalte werden nicht für Modelltraining verwendet.

Erstellen Sie einen kostenlosen Chatbot

Kostenloser Tarif. Keine Karte nötig.