01
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.
MkDocs-Support-Bot
Fügen Sie einen KI-Chatbot mit Quellenangaben zu Ihrer MkDocs- und Material-Dokumentation hinzu
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 DokumentseitenQuellenzitierte AntwortenEinbettung mit einem SkriptKeine Dokumentenmigration erforderlichKeine Kreditkarte erforderlichIhre Inhalte bleiben Ihre Inhalte
Melden Sie sich an, um unseren Free-Tarif zu testen
Evaluieren Sie ChattyBox für eine Organisation? Kontaktieren Sie den Support und besprechen Sie einen Testzeitraum für einen umfangreicheren Tarif.
ChattyBox fragen
xWo 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 quellenbelegten Chatbot, ohne Ihren Website-Stack neu aufzubauen
ChattyBox crawlt Ihre bestehende Website, Dokumentation, Ihr Help Center, CMS oder Ihre Wissensdatenbank und bettet anschließend einen Chatbot ein, der aus Ihren eigenen veröffentlichten Inhalten statt aus dem allgemeinen Modellgedächtnis antwortet.
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.
1Workflow-Schritt
Crawlen Sie die bereitgestellte MkDocs-Sitemap oder die stabilen und versionierten Pfade, die Sie bewusst unterstützen.
2Workflow-Schritt
Testen Sie Produkt-, Python- und API-Fragen und öffnen Sie vor der Installation jede Quellenangabe.
3Workflow-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.
4Workflow-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.
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.
02
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.
03
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.
04
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
- 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.
| MkDocs-Aspekt | Implementierungsentscheidung | Überprüfung |
|---|---|---|
MkDocs-Aspekt Material-Überschreibung | Implementierungsentscheidung 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. | Überprüfung Erstellen und starten Sie die Website und bestätigen Sie anschließend, dass Suche und Navigation von Material weiterhin funktionieren. |
MkDocs-Aspekt Standard-MkDocs | Implementierungsentscheidung 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. | Überprüfung 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. |
MkDocs-Aspekt Asynchrones Laden und Duplikate | Implementierungsentscheidung 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. | Überprüfung Bestätigen Sie nach vollständigem Laden und Sofortübergängen von Material, dass document.querySelectorAll("#chattybox-widget").length den Wert 1 hat. |
MkDocs-Aspekt Content Security Policy | Implementierungsentscheidung 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. | Überprüfung Prüfen Sie die Browserkonsole und den Network-Bereich auf blockierte Skript-, Stil-, Schrift-, Fetch- oder WebSocket-Anfragen. |
MkDocs-Aspekt Suche, Sofortnavigation und Mobilgeräte | Implementierungsentscheidung Behalten Sie Theme-Skripte mit super() bei und halten Sie den Starter von Suchdialog, Navigationsleiste, Paginierung und Einwilligungssteuerelementen frei. | Überprüfung Testen Sie die Tastatursuche, mehrere Sofortlinks und einen 390 Pixel breiten Ansichtsbereich ohne Überlappung oder horizontales Scrollen. |
MkDocs-Aspekt mike-Versionen | Implementierungsentscheidung 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. | Überprüfung Verwenden Sie mike serve, um den Versionswechsel zu testen und zu bestätigen, dass Quellenangaben innerhalb der vorgesehenen Version aufgelöst werden. |
MkDocs-Aspekt Fehler bei Widget oder Quellenangabe | Implementierungsentscheidung 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. | Überprüfung 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
xWie 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.
Eine Frage stellen...
Bereitgestellt von ChattyBox
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.Ausführbare MkDocs-BeispieleMaterial- und Vanilla-MkDocs-Beispiele mit Theme-Überschreibungen, Testseiten und den aktuellen Widget-Attributen.
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.
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
01KI-Chatbot für DokumentationSehen Sie den dokumentationsorientierten Chatbot-Workflow mit Quellenangaben, der plattformübergreifend funktioniert.02API-Dokumentations-ChatbotBeantworten Sie Endpoint-, Parameter- und Authentifizierungsfragen aus Python- und API-Referenzdocs.03Docusaurus KI-ChatbotVergleichen Sie denselben quellengestützten Workflow für Docusaurus-Dokumentationssites.04Alle Plattform-Guides anzeigenFinden Sie Setup-Guides für Docusaurus, VitePress, Starlight, Nextra, Mintlify, ReadMe und weitere Docs-Plattformen.
Häufige Fragen
Häufige Fragen
1
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.
2
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.
3
Kann der Bot aus versionierten Docs antworten?
Ja, wenn die versionierten Docs-Seiten öffentlich sind und im Crawl oder in der Sitemap enthalten sind.
4
Kann es Dokumentationslücken erkennen?
Ja. ChattyBox Analytics helfen dabei, Fragen sichtbar zu machen, die Ihre MkDocs-Inhalte noch nicht klar beantworten.
Melden Sie sich an, um unseren Free-Tarif zu testen
Evaluieren Sie ChattyBox für eine Organisation? Kontaktieren Sie den Support und besprechen Sie einen Testzeitraum für einen umfangreicheren Tarif.