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.
AI chatbot pro dokumentaci MkDocs a Material for MkDocs. ChattyBox prochází váš veřejný web a odpovědi mohou obsahovat odkazy na vyhledané stránky. Ověřujte správnost odpovědí a citací. Není třeba udržovat žádnou indexovací pipeline v Pythonu ani vlastní RAG.
ChattyBox prochází váš stávající web, dokumentaci, centrum nápovědy, CMS nebo znalostní bázi. Získaný obsah může sloužit jako podklad pro odpovědi chatbota; ověřujte správnost odpovědí a citací.
Procházejte nasazenou mapu webu MkDocs nebo stabilní a verzované cesty, které záměrně podporujete.
Otestujte otázky k produktu, Pythonu a API a před instalací otevřete každou citaci.
Pro Material nakonfigurujte theme.custom_dir a rozšiřte base.html z overrides/main.html při zachování bloku scripts pomocí super().
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
Týmy MkDocs obvykle chtějí rychlé statické sestavení, jasnou navigaci a čitelný technický obsah. ChattyBox zachová tento pracovní postup a zároveň přidá na publikovaný web asistenta, který uvádí zdroje.
Pomocí těchto kontrolních bodů se můžete rozhodnout, zda má ChattyBox fungovat vedle vaší dokumentační platformy, nahradit samostatného asistenta nebo zůstat oddělený pro testování.
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.
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.
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ů.
V tarifu Pro nebo Business prověřujte označené otázky jako heuristické signály možných chybějících příkladů, nejasných kroků instalace nebo zastaralých stránek pro řešení problémů.
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í.
Po upgradu motivu znovu zkontrolujte bloky šablony a okamžitou navigaci; obsah znovu projděte pokaždé, když se změní alias mike.
| Oblast MkDocs | Prováděcí rozhodnutí | Ověření |
|---|---|---|
Oblast MkDocs Přepsání Material | Prováděcí rozhodnutí 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. | Ověření Sestavte a spusťte web a poté ověřte, že vyhledávání a navigace Material stále fungují. |
Oblast MkDocs Základní MkDocs | Prováděcí rozhodnutí 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. | Ověření Spusťte mkdocs serve a ověřte vyhledávání, další a předchozí odkazy a widget na více než jedné stránce. |
Oblast MkDocs Asynchronní načítání a duplikáty | Prováděcí rozhodnutí 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. | Ověření Po plném načtení a okamžitých přechodech Material potvrďte, že document.querySelectorAll("#chattybox-widget").length je 1. |
Oblast MkDocs Zásady zabezpečení obsahu | Prováděcí rozhodnutí 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. | Ověření Zkontrolujte konzolu prohlížeče a panel Network, zda nejsou blokovány požadavky na skript, styl, font, načítání dat nebo WebSocket. |
Oblast MkDocs Vyhledávání, okamžitá navigace a mobilní zařízení | Prováděcí rozhodnutí 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. | Ověření 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í. |
Oblast MkDocs mike verze | Prováděcí rozhodnutí 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. | Ověření Pomocí mike serve otestujte přepínání verzí a potvrďte vyřešení citací v zamýšlené verzi. |
Oblast MkDocs Selhání widgetu nebo citace | Prováděcí rozhodnutí 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í. | Ověření Prohlédněte si vygenerované HTML a otestujte produkční artefakt; nespoléhejte pouze na živé načítání změn. |
Položte otázku k motivu 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.
Praktický kontrolní seznam pro vyhodnocení AI chatbotů pro dokumentaciPro 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.
{% 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 %}Ano. ChattyBox může procházet veřejné stránky MkDocs a Material for MkDocs a lze jej vložit jako běžný webový widget.
Ne. Po konfiguraci chatbota přidejte fragment widgetu do šablony webu nebo do vlastní úpravy motivu.
Ano, pokud jsou stránky dokumentů s verzemi veřejné a zahrnuty v procházení nebo mapě webu.
V tarifu Pro nebo Business jsou označené otázky heuristickými signály možných mezer, které je třeba prověřit, nikoli definitivní diagnózou obsahu MkDocs.