Współpracuje ze stronami Material for MkDocs
Indeksuj przewodniki, strony referencyjne i wygenerowany statyczny HTML z publicznych witryn MkDocs lub Material for MkDocs bez zmiany motywu.
Chatbot AI dla dokumentacji MkDocs i Material for MkDocs. ChattyBox przeszukuje Twoją publiczną witrynę i może umieszczać w odpowiedziach linki do pobranych stron. Sprawdź poprawność odpowiedzi i cytatów. Bez potoku indeksowania w Pythonie i własnego RAG do utrzymania.
ChattyBox indeksuje istniejącą witrynę, dokumentację, centrum pomocy, CMS lub bazę wiedzy. Pobrane treści mogą pomagać chatbotowi w tworzeniu odpowiedzi; sprawdzaj poprawność odpowiedzi i cytowań.
Przeszukaj wdrożoną mapę witryny MkDocs lub stabilne i wersjonowane ścieżki, które celowo obsługujesz.
Przetestuj pytania dotyczące produktów, Python i API i otwórz każdy cytat przed instalacją.
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().
Sprawdź wbudowaną wyszukiwarkę, natychmiastową nawigację, sterowanie mobilne, CSP i każdą opublikowaną wersję mike.
Uruchomienie w trzech krokach
Zespoły MkDocs zazwyczaj chcą szybkich kompilacji statycznych, przejrzystej nawigacji i czytelnej treści technicznej. ChattyBox zachowuje ten sposób pracy, dodając do opublikowanej witryny asystenta cytującego źródła.
Skorzystaj z tych punktów kontrolnych, aby zdecydować, czy ChattyBox powinien działać obok Twojej platformy dokumentacyjnej, zastąpić osobnego asystenta, czy też pozostać odizolowany na czas testów.
Indeksuj przewodniki, strony referencyjne i wygenerowany statyczny HTML z publicznych witryn MkDocs lub Material for MkDocs bez zmiany motywu.
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.
Ponieważ ChattyBox przeszukuje witrynę publiczną, zespoły nie muszą dodawać indeksowania wektorowego do potoku kompilacji MkDocs ani skryptów CI.
W planie Pro lub Business przejrzyj oznaczone pytania jako heurystyczne sygnały możliwego braku przykładów, niejasnych kroków instalacji lub nieaktualnych stron dotyczących rozwiązywania problemów.
Zarówno Material for MkDocs, jak i wbudowany motyw MkDocs obsługują dziedziczenie szablonów, ale powinny używać oddzielnych katalogów niestandardowych. Poniższy sposób instalacji w Material zachowuje blok skryptów za pomocą super(), dodaje jeden asynchroniczny moduł ładujący i działa przy natychmiastowej nawigacji bez zastępowania wyszukiwarki.
Sprawdź ponownie bloki szablonów i zachowanie natychmiastowej nawigacji po aktualizacji motywu i przeszukaj ponownie za każdym razem, gdy alias mike zostanie przeniesiony.
| Problem MkDocs | Decyzja wdrożeniowa | Weryfikacja |
|---|---|---|
Problem MkDocs Nadpisanie Material | Decyzja wdrożeniowa Ustaw theme.name na material i theme.custom_dir na overrides. Rozszerz base.html, nadpisz blok scripts, wywołaj super(), a następnie dodaj skrypt widżetu. | Weryfikacja Zbuduj i obsłuż witrynę, a następnie potwierdź, że wyszukiwanie Material i nawigacja nadal działają. |
Problem MkDocs Vanilla MkDocs | Decyzja wdrożeniowa Użyj theme.name: mkdocs z oddzielnym katalogiem custom_theme. Dodaj równoważne zastąpienie custom_theme/main.html zamiast kopiować szablony Material. | Weryfikacja Uruchom mkdocs serve i sprawdź wyszukiwanie, następne i poprzednie linki oraz widżet na więcej niż jednej stronie. |
Problem MkDocs Ładowanie asynchroniczne i duplikaty | Decyzja wdrożeniowa 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ęść. | Weryfikacja Po pełnym załadowaniu i natychmiastowym przejściu Material potwierdź, że document.querySelectorAll("#chattybox-widget").length ma wartość 1. |
Problem MkDocs Polityka bezpieczeństwa treści | Decyzja wdrożeniowa 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. | Weryfikacja Sprawdź konsolę przeglądarki i panel Network pod kątem zablokowanych żądań skryptów, stylów, czcionek, fetch lub WebSocket. |
Problem MkDocs Wyszukiwanie, natychmiastowa nawigacja i urządzenia mobilne | Decyzja wdrożeniowa Zachowaj skrypty motywu za pomocą super() i umieść przycisk uruchamiający z dala od okna wyszukiwania, szuflady, paginacji i elementów sterujących zgodą. | Weryfikacja 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. |
Problem MkDocs Wersje mike | Decyzja wdrożeniowa 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. | Weryfikacja Użyj mike serve, aby przetestować przełączanie wersji i potwierdzić, że cytowane odnośniki prowadzą do właściwej wersji. |
Problem MkDocs Błąd widżetu lub cytatu | Decyzja wdrożeniowa Sprawdź wcięcia YAML, aktywny custom_dir, nazwę dziedziczonego bloku, klucz API, CSP, zawartość mapy witryny oraz to, czy wdrożona kompilacja zawiera nadpisanie. | Weryfikacja Sprawdź wygenerowany HTML i przetestuj artefakt produkcyjny, zamiast polegać tylko na przeładowywaniu na żywo. |
Użyj pytania o motyw z możliwą do sprawdzenia regułą szablonu, a następnie otwórz cytowanie i potwierdź, że pasuje do wersji wybranej przez odwiedzającego.
Praktyczna lista kryteriów oceny chatbotów AI do dokumentacjiW 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.
{% 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 %}Tak. ChattyBox może przeszukiwać publiczne strony MkDocs i Material for MkDocs oraz zostać osadzony jako standardowy widżet witryny.
Nie. Po skonfigurowaniu chatbota dodaj fragment kodu widżetu do szablonu witryny lub nadpisania motywu.
Tak, jeśli wersjonowane strony dokumentów są publiczne i uwzględnione w indeksowaniu lub mapie witryny.
W planie Pro lub Business oznaczone pytania są heurystycznymi sygnałami możliwych luk, które warto sprawdzić, a nie definitywną diagnozą treści MkDocs.