MkDocs Podpora Bot

MkDocs AI Chatbot pro MkDocs Dokumentace

AI chatbot pro dokumentaci MkDocs a Material for MkDocs. ChattyBox prochází váš veřejný web, odpovídá na otázky jako „Jak zapnu navigační záložky?“ přímo z těchto stránek a cituje zdroj. Není třeba udržovat žádnou indexovací pipeline v Pythonu ani vlastní RAG.

Prochází stránky publikovaných dokumentů

Odpovědi citované zdrojem

Vloží s jedním skriptem

Nevyžaduje se migrace dokumentů

Vytvořte si zdarma chatbota MkDocs AI Přečtěte si průvodce nastavením

Není vyžadována kreditní kartaVáš obsah zůstává váš

Zeptejte se ChattyBox

Kde mám začít, když potřebuji spolehlivou odpověď z tohoto webu?

Začněte přidáním adresy URL svého webu do ChattyBox. Prochází váš obsah, odpovídá ze stránek, které najde, a ukazuje návštěvníkům zdroje za každou odpovědí.

iZdroje3^

MkDocs průvodce

chattybox.ai

Analytika

chattybox.ai

Domov

chattybox.ai

Zeptejte se...

Běží na ChattyBox

Vytvořeno pro MkDocs týmy

Spusťte chatbota s citovaným zdrojem, aniž byste museli znovu sestavovat svůj zásobník dokumentů

ChattyBox prochází vaši stávající dokumentaci, indexuje obsah pro vyhledání a vkládá chatbota, který odpovídá pomocí vašich dokumentů namísto obecné paměti modelu.

Přepsání Material zachová motiv JavaScript a přidá jeden asynchronní zavaděč widgetů.

Vanilla MkDocs používá samostatný vlastní adresář motivů namísto předpokládaných cest Material.

Kontroly pokrývají souběžné fungování vyhledávání, okamžitou navigaci, duplicitní zavaděče a úzké mobilní obrazovky.

Výběr procházených verzí záměrně rozlišuje stabilní, nejnovější a starší trasy mike.

Krok pracovního postupu

Procházejte nasazenou mapu webu MkDocs nebo stabilní a verzované cesty, které záměrně podporujete.

Krok pracovního postupu

Otestujte produkt, otázky Python a API a před instalací otevřete každou citaci.

Krok pracovního postupu

Pro Material nakonfigurujte theme.custom_dir a rozšiřte base.html z overrides/main.html při zachování bloku scripts pomocí super().

Krok pracovního postupu

Ověřte vestavěné vyhledávání, okamžitou navigaci, ovládání na mobilu, CSP a každou publikovanou verzi mike.

Spuštění ve třech krocích

Vložte svou adresu URL MkDocs, otestujte citované odpovědi a nainstalujte widget.

Vytvořte si zdarma chatbota MkDocs AI

Pracovní postup specifický pro MkDocs

Konverzační podpora pro statické stránky s dokumentací Pythonu

Týmy MkDocs obvykle chtějí rychlé statické sestavení, jasnou navigaci a čitelný technický obsah. ChattyBox zachová tento pracovní postup nedotčený a zároveň přidá na publikovaný web asistenta citovaného zdrojem.

Cesta rozhodnutí

Pomocí těchto kontrolních bodů se můžete rozhodnout, zda má ChattyBox sedět vedle vaší platformy dokumentů, nahradit samostatného asistenta nebo zůstat izolovaný pro testování.

Pracuje se stránkami Material for MkDocs

Indexujte průvodce, referenční stránky a vygenerovaný statický HTML z veřejných nasazení MkDocs nebo Material for MkDocs bez nahrazení vašeho motivu.

S verzovanou dokumentací zacházejte záměrně

Namiřte ChattyBox na cesty k verzím, na které se mají uživatelé ptát, a poté otestujte, zda odpovědi citují zamýšlené stabilní, nejnovější nebo starší dokumenty.

Není třeba udržovat žádnou úlohu indexování Pythonu

Protože ChattyBox prochází veřejný web, týmy nemusejí přidávat indexování vektorů do svých skriptů sestavování MkDocs nebo CI skriptů.

Vylepšete dokumenty ze skutečných otázek

Použijte nezodpovězené otázky k identifikaci chybějících příkladů, nejasných kroků instalace nebo zastaralých stránek pro odstraňování problémů na vašem webu MkDocs.

Ověřené redakční podklady

Testované instalační cesty Material a vanilla MkDocs

Material for MkDocs i vestavěný motiv MkDocs podporují dědění šablon, ale měly by používat samostatné vlastní adresáře. Níže uvedený postup pro Material zachovává blok scripts pomocí super(), přidává jeden asynchronní zavaděč a funguje i při okamžité navigaci, aniž by nahrazoval chování vyhledávání.

Technický autor: Dokumentační tým ChattyBox
Technický recenzent: Technický tým ChattyBox
Naposledy aktualizováno: 2026-07-09
Informace zkontrolovány: MkDocs, Material for MkDocs a mike

Po upgradu motivu znovu zkontrolujte bloky šablony a okamžitou navigaci; obsah znovu projděte pokaždé, když se změní alias mike.

Konfigurace custom_dir v Material for MkDocs a přepsání hlavní šablony se zachováním skriptů motivu — Původní instalační odkaz: theme.custom_dir vybere přepsání a super() zachová vyhledávací a navigační skripty Material nedotčené.

Rozhodnutí o instalaci Material a vanilla MkDocs s komplexními kontrolami.
Oblast MkDocs	Prováděcí rozhodnutí	Ověření
Přepsání Material	Nastavte theme.name na material a theme.custom_dir na overrides. Rozšiřte base.html, přepište blok scripts, zavolejte super() a poté přidejte skript widgetu.	Sestavte a spusťte web a poté ověřte, že vyhledávání a navigace Material stále fungují.
Základní MkDocs	Použijte theme.name: mkdocs se samostatným adresářem custom_theme. Místo kopírování šablon Material přidejte ekvivalentní přepsání custom_theme/main.html.	Spusťte mkdocs serve a ověřte vyhledávání, další a předchozí odkazy a widget na více než jedné stránce.
Asynchronní načítání a duplikáty	Ponechte jeden zavaděč ve zděděném bloku scripts, přidělte mu stabilní ID a nepřidávejte stejný fragment přes extra_javascript ani jinou částečnou šablonu.	Po plném načtení a okamžitých přechodech Material potvrďte, že document.querySelectorAll("#chattybox-widget").length je 1.
Zásady zabezpečení obsahu	Povolte chattybox.ai v script-src, nakonfigurovaný původ API v connect-src, fonts.googleapis.com ve style-src a fonts.gstatic.com ve font-src. Současný widget vkládá vlastní CSS komponenty, takže přísné style-src vyžaduje také 'unsafe-inline', dokud nebude k dispozici varianta s nonce nebo externím stylem.	Zkontrolujte konzolu prohlížeče a panel Network, zda nejsou blokovány požadavky na skript, styl, font, načítání dat nebo WebSocket.
Vyhledávání, okamžitá navigace a mobilní zařízení	Zachovejte skripty motivu pomocí super() a umístěte spouštěč mimo vyhledávací dialog, postranní panel, stránkování a ovládací prvky souhlasu.	Vyzkoušejte ovládání vyhledávání klávesnicí, několik odkazů s okamžitou navigací a zobrazení o šířce 390 pixelů bez překrývání či vodorovného posouvání.
mike verze	Záměrně volte cesty stabilní, nejnovější nebo explicitní verze. Po přesunutí aliasu znovu procházet a vyloučit nepodporovaná vydání, pokud by odpovědi napříč verzemi mohly uživatele uvést v omyl.	Pomocí mike serve otestujte přepínání verzí a potvrďte vyřešení citací v zamýšlené verzi.
Selhání widgetu nebo citace	Zkontrolujte odsazení YAML, aktivní custom_dir, zděděný název bloku, klíč API, CSP, obsah mapy webu a zda nasazené sestavení zahrnuje přepsání.	Prohlédněte si vygenerované HTML a otestujte produkční artefakt; nespoléhejte pouze na živé načítání změn.

Kontrola citované odpovědi

Otestujte odpověď proti aktivní verzi

Použijte tématické otázky s ověřitelným pravidlem šablony, poté otevřete citaci a potvrďte, že odpovídá verzi, kterou si návštěvník vybral.

Zeptejte se průvodců MkDocs

Jak přidám widget, aniž bych přerušil vyhledávání Material?

Nastavte theme.custom_dir na overrides, vytvořte overrides/main.html, rozšiřte base.html a za super() přidejte do bloku scripts asynchronní zavaděč. Volání super() zachová skripty, které Material používá pro vyhledávání a navigaci.

iZdroje2^

Material: přizpůsobení

squidfunk.github.io/mkdocs-material

MkDocs: přizpůsobení vašeho motivu

mkdocs.org/user-guide

Zeptejte se...

Běží na ChattyBox

Původní mobilní reference: vyhledávání zůstává dostupné, spouštěč má použitelný dotykový cíl a stránka se neposouvá vodorovně.

Primární zdroje a reprodukovatelné důkazy

Přizpůsobení Material for MkDocsOficiální custom_dir, dědění šablony a pokyny pro přepisování bloků.Okamžitá navigace MaterialOficiální chování pro nahrazení dokumentu bez opětovného načtení celé stránky.Přizpůsobení motivu MkDocsOficiální vlastní adresář motivů, základní šablona a pokyny super() pro vanilla MkDocs.Verzovaná dokumentace pomocí mikeNasazení verze, aliasy, výchozí verze a místní testování více verzí.Reprodukovatelné příklady MkDocsOddělte projekty Material a vanilla s otestovanými přepisy šablon.

Instalační cesta

Jak přidat widget do MkDocs

Pro Material for MkDocs nastavte theme.custom_dir na overrides, rozšiřte base.html v overrides/main.html a před asynchronním skriptem widgetu zavolejte super(). Vanilla MkDocs potřebuje vlastní adresář motivu a ekvivalentní přepsání main.html.

1Vytvořte projekt ChattyBox a zadejte adresu URL nebo mapu webu MkDocs nebo Material for MkDocs.
2Otestujte skutečné otázky MkDocs na řídicím panelu a potvrďte, že citace směřují na správné stránky.
3Přidejte otestované přepsání, sestavte web a ověřte vyhledávání, navigaci, CSP a chování na mobilu.

Vytvořte si zdarma chatbota MkDocs AI

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

Další prozkoumat

Více způsobů, jak používat ChattyBox

Prozkoumejte všechna řešení

AI chatbot pro dokumentaci

Podívejte se na pracovní postup chatbota s dokumentací citovanou ze zdroje, který platí pro různé platformy.

OTEVŘENO

API dokumentační chatbot

Odpovězte na otázky týkající se koncových bodů, parametrů a ověřování z Pythonu a referenčních dokumentů API.

OTEVŘENO

Docusaurus AI chatbot

Porovnejte stejný uzemněný pracovní postup pro dokumentační weby Docusaurus.

OTEVŘENO

Prohlédněte si všechny průvodce platformami

Najděte průvodce nastavením pro platformy Docusaurus, VitePress, Starlight, Nextra, Mintlify, ReadMe a další.

OTEVŘENO

Časté dotazy

Běžné otázky

Funguje ChattyBox s Material for MkDocs?

Ano. ChattyBox může procházet veřejné stránky MkDocs a Material for MkDocs a vkládat je jako standardní widget webu.

Musím změnit svůj kanál sestavení Pythonu?

Ne. Po konfiguraci chatbota přidejte fragment widgetu do šablony webu nebo přepište motiv.

Může robot odpovědět z verzovaných dokumentů?

Ano, pokud jsou stránky dokumentů s verzemi veřejné a zahrnuty v procházení nebo mapě webu.

Dokáže identifikovat mezery v dokumentaci?

Ano. Analytika ChattyBox pomáhá odhalit otázky, na které váš obsah MkDocs zatím jasně neodpovídá.

Začněte zdarma

Není vyžadována kreditní karta. Váš obsah se nepoužívá k trénování modelů.

Vytvořte si chatbota zdarma

Tarif Free. Bez karty.