Przejdź do głównej treści
MkDocs Bot wsparcia

Dodaj chatbota AI z cytowanymi źródłami do swojej dokumentacji MkDocs i Material

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.

Indeksuje opublikowane strony dokumentacjiOdpowiedzi z cytowaniami źródełOsadzenie jednym skryptemBez migracji dokumentacjiKarta 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 publicznej witryny do ChattyBox. Wyszukuje zindeksowane treści, aby ukierunkować odpowiedzi, i może pokazywać odnośniki do stron źródłowych do sprawdzenia przez odwiedzających. Przetestuj odpowiedzi i zachowanie awaryjne przed uruchomieniem.
iŹródła3^
MkDocs przewodnik
chattybox.ai
Analityka
chattybox.ai
Strona główna
chattybox.ai

Przykładowa rozmowa — to nie jest czat na żywo.

Obsługiwane przez ChattyBox

Uruchom chatbota z cytowaniami źródeł bez przebudowy stosu witryny

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ń.

Nadpisanie motywu Material zachowuje jego kod JavaScript i dodaje jeden asynchroniczny moduł ładujący widżet.
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 zakresu przeszukiwania uwzględniający wersje pozwala świadomie wybrać stabilne, najnowsze i starsze ścieżki 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.

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 treści technicznej. ChattyBox zachowuje ten sposób pracy, dodając do opublikowanej witryny asystenta cytującego źródła.

Ścieżka decyzji

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.

01

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.

02

Świadomie zarządzaj wersjami dokumentacji

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.

03

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.

04

Ulepszaj dokumenty na podstawie prawdziwych pytań

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.

Sprawdzone dowody redakcyjne

Przetestowane sposoby instalacji dla Material i standardowego MkDocs

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.

Autor techniczny
Zespół dokumentacji ChattyBox
Recenzent techniczny
Inżynieria ChattyBox
Ostatnia aktualizacja
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 MkDocsDecyzja wdrożeniowaWeryfikacja
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.
Sprawdzanie cytowanych odpowiedzi

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

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 dokumentacji
Zapytaj przewodniki MkDocs
Jak dodać widżet bez zakłócania wyszukiwania Material?
Ustaw theme.custom_dir na overrides, utwórz overrides/main.html, rozszerz base.html i dodaj asynchroniczny moduł ładujący w bloku scripts po super(). Wywołanie super() zachowuje skrypty używane przez Material do wyszukiwania i nawigacji.

Przykładowa rozmowa — to nie jest czat na żywo.

Obsługiwane przez ChattyBox
Strona mobilna Material for MkDocs z wyszukiwarką i ChattyBox widoczne bez nakładających się elementów sterujących
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.
Ś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.

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

Często zadawane pytania

1

Czy ChattyBox współpracuje z Material for MkDocs?

Tak. ChattyBox może przeszukiwać publiczne strony MkDocs i Material for MkDocs oraz zostać osadzony jako standardowy widżet witryny.

2

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

Nie. Po skonfigurowaniu chatbota dodaj fragment kodu widżetu do szablonu witryny lub nadpisania motywu.

3

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.

4

Czy może zidentyfikować luki w dokumentacji?

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.