MkDocs Bot wsparcia

MkDocs Chatbot AI dla MkDocs Dokumentacja

Chatbot AI dla dokumentacji MkDocs i Material for MkDocs. ChattyBox przeszukuje Twoją publiczną witrynę, odpowiada na pytania typu „Jak włączyć zakładki nawigacji?” na podstawie tych stron i cytuje źródło. Bez potoku indeksowania w Pythonie i bez własnego RAG do utrzymania.

Indeksuje opublikowane strony dokumentacji

Odpowiedzi z cytowaniami źródeł

Osadzenie jednym skryptem

Bez migracji dokumentacji

Utwórz bezpłatnie chatbota AI dla MkDocs Przeczytaj przewodnik konfiguracji

Karta kredytowa nie jest wymaganaTwoje treści pozostają Twoje

Zapytaj ChattyBox

Od czego zacząć, jeśli potrzebuję wiarygodnej odpowiedzi z tej strony?

Zacznij od dodania adresu URL swojej strony do ChattyBox. Narzędzie indeksuje Twoje treści, odpowiada na podstawie znalezionych stron i pokazuje odwiedzającym źródła każdej odpowiedzi.

iŹródła3^

MkDocs przewodnik

chattybox.ai

Analityka

chattybox.ai

Strona główna

chattybox.ai

Zadaj pytanie...

Obsługiwane przez ChattyBox

Zbudowany dla Zespoły MkDocs

Uruchom chatbota cytowanego w źródle bez konieczności ponownego tworzenia stosu dokumentów

ChattyBox przeszukuje istniejącą dokumentację, indeksuje treść w celu pobrania i osadza chatbota, który odpowiada, korzystając z dokumentów zamiast ogólnej pamięci modelu.

Zastąpienie Material zachowuje motyw JavaScript i dodaje jeden asynchroniczny moduł ładujący widżety.

Vanilla MkDocs wykorzystuje oddzielny, niestandardowy katalog motywów zamiast zakładać ścieżki Material.

Kontrole obejmują współistnienie wyszukiwania, natychmiastową nawigację, zduplikowane moduły ładujące i wąskie rzutnie mobilne.

Wybór indeksowania uwzględniający wersję pozwala zachować stabilne, najnowsze i starsze trasy mike.

Krok przepływu pracy

Przeszukaj wdrożoną mapę witryny MkDocs lub stabilne i wersjonowane ścieżki, które celowo obsługujesz.

Krok przepływu pracy

Przetestuj pytania dotyczące produktów, Python i API i otwórz każdy cytat przed instalacją.

Krok przepływu pracy

W przypadku Material skonfiguruj theme.custom_dir i rozszerz base.html z overrides/main.html, zachowując jednocześnie blok skryptów za pomocą super().

Krok przepływu pracy

Sprawdź wbudowaną wyszukiwarkę, natychmiastową nawigację, sterowanie mobilne, CSP i każdą opublikowaną wersję mike.

Uruchomienie w trzech krokach

Wklej swój adres URL MkDocs, przetestuj cytowane odpowiedzi, a następnie zainstaluj widżet.

Utwórz bezpłatnie chatbota AI dla MkDocs

Przepływ pracy specyficzny dla MkDocs

Wsparcie konwersacyjne dla statycznych witryn z dokumentacją języka Python

Zespoły MkDocs zazwyczaj chcą szybkich kompilacji statycznych, przejrzystej nawigacji i czytelnej zawartości technicznej. ChattyBox utrzymuje ten przepływ pracy w nienaruszonym stanie, dodając asystenta cytowanego w źródle na opublikowanej witrynie.

Ścieżka decyzji

Skorzystaj z tych punktów kontrolnych, aby zdecydować, czy ChattyBox powinien siedzieć obok Twojej platformy dokumentów, zastąpić osobnego asystenta, czy też pozostać odizolowany na czas testów.

Współpracuje z materiałami dla stron MkDocs

Indeksuj przewodniki, strony referencyjne i wygenerowany statyczny kod HTML z publicznych MkDocs lub materiałów do wdrożeń MkDocs bez wymiany motywu.

Celowo obchodź się z dokumentacją wersjonowaną

Wskaż ChattyBox ścieżki wersji, o które chcesz, aby użytkownicy pytali, a następnie sprawdź, czy odpowiedzi powołują się na zamierzone dokumenty stabilne, najnowsze lub starsze.

Brak zadania indeksowania w języku Python do utrzymania

Ponieważ ChattyBox przeszukuje witrynę publiczną, zespoły nie muszą dodawać indeksowania wektorowego do potoku kompilacji MkDocs ani skryptów CI.

Ulepszaj dokumenty na podstawie prawdziwych pytań

Użyj pytań bez odpowiedzi, aby zidentyfikować brakujące przykłady, niejasne kroki instalacji lub nieaktualne strony rozwiązywania problemów w swojej witrynie MkDocs.

Sprawdzone dowody redakcyjne

Testowany Material i Vanilla ścieżki instalacyjne MkDocs

Zarówno Material for MkDocs, jak i wbudowany motyw MkDocs obsługują dziedziczenie szablonów, ale powinny używać oddzielnych katalogów niestandardowych. Ścieżka Material poniżej zachowuje swój blok skryptów w super(), dodaje jeden moduł ładujący asynchroniczny i pozwala na natychmiastową nawigację bez zmiany zachowania wyszukiwania.

Autor techniczny: Zespół dokumentacji ChattyBox
Recenzent techniczny: Inżynieria ChattyBox
Ostatnia aktualizacja: 2026-07-09
Informacje sprawdzone: MkDocs, Material for MkDocs i mike

Sprawdź ponownie bloki szablonów i zachowanie natychmiastowej nawigacji po aktualizacji motywu i przeszukaj ponownie za każdym razem, gdy alias mike zostanie przeniesiony.

Konfiguracja custom_dir w Material for MkDocs i nadpisanie głównego szablonu zachowujące skrypty motywu — Oryginalne odniesienie do instalacji: theme.custom_dir wybiera zastąpienie, a super() zachowuje nienaruszone skrypty wyszukiwania i nawigacji Material.

Decyzje dotyczące Material i Vanilla MkDocs wraz z kompleksowymi kontrolami.
Problem MkDocs	Decyzja wdrożeniowa	Weryfikacja
Nadpisanie Material	Ustaw theme.name na Material i theme.custom_dir na nadpisania. Rozszerz base.html, zastąp skrypty, wywołaj super(), a następnie dołącz skrypt widżetu.	Zbuduj i obsłuż witrynę, a następnie potwierdź, że wyszukiwanie Material i nawigacja nadal działają.
Vanilla MkDocs	Użyj theme.name: mkdocs z oddzielnym katalogiem custom_theme. Dodaj równoważne zastąpienie custom_theme/main.html zamiast kopiować szablony Material.	Uruchom mkdocs serve i sprawdź wyszukiwanie, następne i poprzednie linki oraz widżet na więcej niż jednej stronie.
Ładowanie asynchroniczne i duplikaty	Zachowaj jeden moduł ładujący w bloku odziedziczonych skryptów, nadaj mu stabilny identyfikator i nie dodawaj tego samego fragmentu poprzez extra_javascript lub inną część.	Po pełnym załadowaniu i natychmiastowym przejściu Material potwierdź, że document.querySelectorAll("#chattybox-widget").length ma wartość 1.
Polityka bezpieczeństwa treści	Zezwól na chattybox.ai w script-src, skonfigurowane pochodzenie API w connect-src, fonts.googleapis.com w style-src oraz fonts.gstatic.com w font-src. Obecny widżet wstrzykuje swój arkusz CSS komponentu, więc restrykcyjny style-src wymaga też 'unsafe-inline', dopóki nie będzie dostępna kompilacja obsługująca nonce lub zewnętrzny arkusz stylów.	Sprawdź konsolę przeglądarki i panel Network pod kątem zablokowanych żądań skryptów, stylów, czcionek, pobierania ani WebSocket.
Wyszukiwanie, natychmiastowa nawigacja i urządzenia mobilne	Zachowaj skrypty motywu za pomocą super() i umieść przycisk uruchamiający z dala od okna wyszukiwania, szuflady, paginacji i elementów sterujących zgodą.	Przetestuj wyszukiwanie z klawiatury, kilka odnośników nawigacji natychmiastowej oraz widok o szerokości 390 pikseli bez nakładania elementów i przewijania w poziomie.
Wersje mike	Celowo wybieraj ścieżki wersji stabilnej, najnowszej lub jawnej. Po przeniesieniu aliasu przeszukaj ponownie i wyklucz nieobsługiwane wersje, jeśli odpowiedzi dotyczące różnych wersji mogłyby wprowadzić użytkowników w błąd.	Użyj mike serve, aby przetestować przełączanie wersji i potwierdzić, że cytaty są zgodne z zamierzoną wersją.
Błąd widżetu lub cytatu	Sprawdź wcięcia YAML, aktywny custom_dir, nazwę dziedziczonego bloku, klucz API, CSP, zawartość mapy witryny oraz to, czy wdrożona kompilacja zawiera nadpisanie.	Sprawdź wygenerowany HTML i przetestuj artefakt produkcyjny, zamiast polegać tylko na przeładowywaniu na żywo.

Sprawdzanie cytowanych odpowiedzi

Przetestuj odpowiedź w porównaniu z aktywną wersją

Użyj pytania tematycznego z weryfikowalną regułą szablonu, a następnie otwórz cytat i potwierdź, że pasuje do wersji wybranej przez odwiedzającego.

Zapytaj przewodniki MkDocs

Jak dodać widżet bez zakłócania wyszukiwania Material?

Ustaw theme.custom_dir na nadpisania, utwórz overrides/main.html, rozszerz base.html i dodaj moduł ładujący asynchroniczny w bloku skryptów po super(). Wywołanie super() zachowuje skrypty używane przez Material do wyszukiwania i nawigacji.

iŹródła2^

Material: dostosowywanie

squidfunk.github.io/mkdocs-material

MkDocs: dostosowywanie motywu

mkdocs.org/user-guide

Zadaj pytanie...

Obsługiwane przez ChattyBox

Oryginalne odniesienie do urządzeń mobilnych: wyszukiwanie pozostaje dostępne, program uruchamiający ma użyteczny cel dotykowy, a strona nie przewija się w poziomie.

Źródła pierwotne i dowody powtarzalne

Dostosowanie Material for MkDocsOficjalne wskazówki dotyczące custom_dir, dziedziczenia szablonów i nadpisywania bloków.Natychmiastowa nawigacja MaterialOficjalne zachowanie przy wymianie dokumentu bez przeładowania całej strony.Dostosowywanie motywu MkDocsOficjalny katalog niestandardowych motywów, szablon podstawowy i wskazówki dotyczące super() dla Vanilla MkDocs.Wersja dokumentacji mikeWdrażanie wersji, aliasy, wersja domyślna i lokalne testowanie wielu wersji.Powtarzalne przykłady MkDocsOddzielne projekty Material i Vanilla z przetestowanymi nadpisaniami szablonów.

Ścieżka instalacji

Jak dodać widget do MkDocs

W przypadku Material for MkDocs ustaw theme.custom_dir na overrides, rozszerz base.html w overrides/main.html i wywołaj super() przed asynchronicznym skryptem widżetu. Vanilla MkDocs wymaga własnego katalogu motywu i równoważnego nadpisania main.html.

1Utwórz projekt ChattyBox i wprowadź adres URL lub mapę witryny MkDocs lub Material for MkDocs.
2Przetestuj prawdziwe pytania MkDocs w panelu kontrolnym i potwierdź, że cytaty prowadzą do właściwych stron.
3Dodaj przetestowane nadpisanie, zbuduj witrynę i zweryfikuj wyszukiwanie, nawigację, CSP oraz zachowanie na urządzeniach mobilnych.

Utwórz bezpłatnie chatbota AI dla MkDocs

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

Zobacz dalej

Więcej sposobów użycia ChattyBox

Przeglądaj wszystkie rozwiązania

Chatbot AI do dokumentacji

Zobacz dokumentację źródłową dotyczącą przepływu pracy chatbota, która ma zastosowanie na różnych platformach.

Otwórz

API chatbot dokumentacyjny

Odpowiedz na pytania dotyczące punktów końcowych, parametrów i uwierzytelniania z dokumentów referencyjnych języka Python i API.

Otwórz

Chatbot Docusaurus AI

Porównaj ten sam, ugruntowany przepływ pracy w witrynach z dokumentacją Docusaurus.

Otwórz

Przeglądaj wszystkie przewodniki po platformach

Znajdź przewodniki konfiguracji dla Docusaurus, VitePress, Starlight, Nextra, Mintlify, ReadMe i innych platform z dokumentacją.

Otwórz

Najczęstsze pytania

Często zadawane pytania

Czy ChattyBox współpracuje z Material for MkDocs?

Tak. ChattyBox może indeksować publiczne strony MkDocs i Material for MkDocs i osadzać je jako standardowy widżet witryny internetowej.

Czy muszę zmienić potok kompilacji języka Python?

Nie. Dodaj fragment widżetu do szablonu swojej witryny lub zastąp motyw po skonfigurowaniu chatbota.

Czy bot może odpowiadać na podstawie wersjonowanych dokumentów?

Tak, jeśli wersjonowane strony dokumentów są publiczne i uwzględnione w indeksowaniu lub mapie witryny.

Czy może zidentyfikować luki w dokumentacji?

Tak. Analityka ChattyBox pomaga odkryć pytania, na które Twoja treść MkDocs nie zawiera jeszcze jasnych odpowiedzi.

Zacznij bezpłatnie

Karta kredytowa nie jest wymagana. Twoje treści nie są używane do trenowania modeli.

Stwórz darmowego chatbota

Plan Free. Bez karty.