Funciona com páginas Material for MkDocs
Indexe guias, páginas de referência e HTML estático gerado de sites públicos MkDocs ou Material for MkDocs sem substituir o seu tema.
Um chatbot de IA para documentação MkDocs e Material for MkDocs. O ChattyBox recolhe conteúdo do seu site público e pode incluir nas respostas ligações para as páginas obtidas. Verifique a exatidão das respostas e citações. Sem pipeline de indexação Python ou RAG personalizado para manter.
O ChattyBox recolhe o conteúdo do seu site, documentação, centro de ajuda, CMS ou base de conhecimento existentes. O conteúdo recuperado pode orientar as respostas do chatbot; verifique a precisão das respostas e das citações.
Recolha o conteúdo do sitemap publicado do MkDocs ou dos caminhos estáveis e versionados que decidiu suportar.
Teste perguntas sobre o produto, Python e API e abra todas as citações antes da instalação.
Para o Material, configure theme.custom_dir e estenda base.html a partir de overrides/main.html, preservando o bloco scripts com super().
Verifique a pesquisa integrada, a navegação instantânea, os controlos em dispositivos móveis, a CSP e cada versão publicada com mike.
Lançamento em três etapas
As equipas MkDocs procuram geralmente compilações estáticas rápidas, navegação clara e conteúdo técnico legível. O ChattyBox mantém esse fluxo de trabalho intacto e acrescenta ao site publicado um assistente com citações de fontes.
Use estes pontos de verificação para decidir se o ChattyBox deve funcionar ao lado da sua plataforma de documentação, substituir um assistente separado ou permanecer isolado para testes.
Indexe guias, páginas de referência e HTML estático gerado de sites públicos MkDocs ou Material for MkDocs sem substituir o seu tema.
Indique ao ChattyBox os caminhos das versões sobre as quais pretende que os utilizadores façam perguntas e teste se as respostas citam a documentação estável, mais recente ou antiga pretendida.
Como o ChattyBox recolhe conteúdo do site público, as equipas não precisam de adicionar indexação vetorial ao pipeline de compilação do MkDocs ou aos scripts de CI.
No Pro ou Business, reveja as perguntas assinaladas como sinais heurísticos de possíveis exemplos em falta, passos de instalação pouco claros ou páginas de resolução de problemas desatualizadas.
Tanto o Material for MkDocs quanto o tema integrado do MkDocs oferecem suporte à herança de templates, mas devem usar diretórios personalizados separados. O caminho do Material abaixo preserva o bloco scripts com super(), adiciona um carregador assíncrono e permanece funcional durante a navegação instantânea sem substituir o comportamento da pesquisa.
Verifique novamente os blocos de template e o comportamento da navegação instantânea após atualizações do tema e refaça o rastreamento sempre que um alias do mike mudar.
| Questão do MkDocs | Decisão de implementação | Verificação |
|---|---|---|
Questão do MkDocs Substituição do Material | Decisão de implementação Defina theme.name como material e theme.custom_dir como overrides. Estenda base.html, substitua scripts, chame super() e depois acrescente o script do widget. | Verificação Gere o build e sirva o site; depois, confirme que a pesquisa e a navegação do Material ainda funcionam. |
Questão do MkDocs MkDocs padrão | Decisão de implementação Use theme.name: mkdocs com um diretório custom_theme separado. Adicione a substituição equivalente em custom_theme/main.html, em vez de copiar templates do Material. | Verificação Execute mkdocs serve e verifique a pesquisa, os links de página anterior e seguinte e o widget em mais de uma página. |
Questão do MkDocs Carregamento assíncrono e duplicados | Decisão de implementação Mantenha um único carregador no bloco scripts herdado, atribua a ele um ID estável e não adicione o mesmo snippet por extra_javascript ou outra parcial. | Verificação Após carregamentos completos e transições instantâneas do Material, confirme que document.querySelectorAll("#chattybox-widget").length é 1. |
Questão do MkDocs Política de Segurança de Conteúdo | Decisão de implementação Permita chattybox.ai em script-src, a origem configurada da API em connect-src, fonts.googleapis.com em style-src e fonts.gstatic.com em font-src. O widget atual injeta o CSS de seu componente, então um style-src estrito também precisa de 'unsafe-inline' até que haja um build com nonce ou stylesheet externo. | Verificação Verifique no console do navegador e no painel Network se há solicitações de script, style, font, fetch ou WebSocket bloqueadas. |
Questão do MkDocs Pesquisa, navegação instantânea e dispositivos móveis | Decisão de implementação Preserve os scripts do tema com super() e mantenha o inicializador afastado da caixa de diálogo de pesquisa, do menu lateral, da paginação e dos controles de consentimento. | Verificação Teste a pesquisa pelo teclado, vários links instantâneos e uma viewport de 390 pixels sem sobreposição nem rolagem horizontal. |
Questão do MkDocs Versões do mike | Decisão de implementação Escolha deliberadamente caminhos stable, latest ou de versões explícitas. Repita a recolha após mover um alias e exclua versões sem suporte quando respostas de outras versões puderem induzir os utilizadores em erro. | Verificação Use mike serve para testar a troca de versões e confirmar que as citações são abertas na versão pretendida. |
Questão do MkDocs Falha no widget ou na citação | Decisão de implementação Verifique a indentação do YAML, o custom_dir ativo, o nome do bloco herdado, a chave da API, a CSP, o conteúdo do sitemap e se o build implantado inclui a substituição. | Verificação Inspecione o HTML gerado e teste o artefato de produção, em vez de depender apenas do live reload. |
Use uma pergunta sobre o tema com uma regra de template verificável; depois, abra a citação e confirme que ela corresponde à versão selecionada pelo visitante.
Lista prática de avaliação de chatbots de IA para documentaçãoPara Material for MkDocs, defina theme.custom_dir como overrides, estenda base.html em overrides/main.html e chame super() antes do script assíncrono do widget. O MkDocs normal precisa do seu próprio diretório de tema personalizado e de uma substituição equivalente em 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 %}Sim. O ChattyBox pode recolher conteúdo de páginas públicas MkDocs e Material for MkDocs e ser incorporado como um widget normal de site.
Não. Adicione o snippet do widget ao modelo do site ou à substituição do tema depois de configurar o chatbot.
Sim, se as páginas de documentação versionada forem públicas e estiverem incluídas na recolha ou no sitemap.
No Pro ou Business, as perguntas assinaladas são sinais heurísticos de possíveis lacunas a investigar, não diagnósticos definitivos do seu conteúdo MkDocs.