01
Funciona com material para páginas MkDocs
Guias de indexação, páginas de referência e HTML estático gerado a partir de implantações públicas de MkDocs ou Material para MkDocs sem substituir seu tema.
MkDocs Bot de suporte
Adicione um chatbot de IA com citações de fontes à sua documentação do MkDocs e do Material
Um chatbot de IA para documentação MkDocs e Material for MkDocs. O ChattyBox rastreia seu site público, responde a perguntas como "Como faço para ativar as abas de navegação?" a partir dessas páginas e cita a fonte. Sem pipeline de indexação Python ou RAG personalizado para manter.
Rastreia páginas de documentos publicadosRespostas citadas pela fonteIncorpora com um scriptNão é necessária migração de documentosNão é necessário cartão de créditoO seu conteúdo continua a ser seu
Cadastre-se para testar nosso plano Free
Está avaliando o ChattyBox para uma organização? Entre em contato com o suporte para conversar sobre um período de teste de um plano mais completo.
Pergunte ao ChattyBox
xPor onde devo começar se preciso de uma resposta confiável deste site?
Comece adicionando o URL do seu site ao ChattyBox. Ele rastreia seu conteúdo, responde a partir das páginas que encontra e mostra aos visitantes as fontes por trás de cada resposta.
iFontes3^
MkDocs guia
chattybox.ai
Análises
chattybox.ai
Início
chattybox.ai
Faça uma pergunta...
Distribuído por ChattyBox
Construído para Equipes MkDocs
Lance um chatbot com citações de fontes sem reconstruir sua stack do site
O ChattyBox rastreia seu site, documentação, central de ajuda, CMS ou base de conhecimento existentes e, em seguida, incorpora um chatbot que responde com base no seu próprio conteúdo publicado, em vez da memória genérica do modelo.
A substituição do Material preserva o JavaScript do tema e adiciona um único carregador assíncrono do widget.
O MkDocs padrão usa um diretório de tema personalizado separado, em vez de pressupor os caminhos do Material.
As verificações abrangem a coexistência da pesquisa, a navegação instantânea, carregadores duplicados e viewports estreitas de dispositivos móveis.
A seleção de rastreamento com reconhecimento de versão mantém intencionais as rotas stable, latest e legadas do mike.
1Etapa do fluxo de trabalho
Rastreie o sitemap implantado do MkDocs ou os caminhos estáveis e versionados que você oferece intencionalmente.
2Etapa do fluxo de trabalho
Teste perguntas sobre o produto, Python e API e abra todas as citações antes da instalação.
3Etapa do fluxo de trabalho
Para o Material, configure theme.custom_dir e estenda base.html a partir de overrides/main.html, preservando o bloco scripts com super().
4Etapa do fluxo de trabalho
Verifique a pesquisa integrada, a navegação instantânea, os controles móveis, a CSP e cada versão publicada com mike.
Lançamento em três etapas
Cole seu URL MkDocs, teste as respostas citadas e instale o widget.
Fluxo de trabalho específico do MkDocs
Suporte conversacional para sites estáticos de documentação Python
As equipes MkDocs geralmente desejam construções estáticas rápidas, navegação clara e conteúdo técnico legível. ChattyBox mantém esse fluxo de trabalho intacto ao adicionar um assistente citado pela fonte no topo do site publicado.
Caminho de decisão
Use esses pontos de verificação para decidir se ChattyBox deve ficar ao lado de sua plataforma de documentos, substituir um assistente separado ou permanecer isolado para testes.
02
Lidar com documentação versionada deliberadamente
Aponte ChattyBox para os caminhos de versão que você deseja que os usuários perguntem e teste se as respostas citam os documentos estáveis, mais recentes ou legados pretendidos.
03
Nenhum trabalho de indexação Python para manter
Como ChattyBox rastreia o site público, as equipes não precisam adicionar indexação vetorial ao pipeline de construção do MkDocs ou aos scripts de CI.
04
Melhore os documentos a partir de perguntas reais
Use perguntas não respondidas para identificar exemplos ausentes, etapas de instalação pouco claras ou páginas de solução de problemas desatualizadas em seu site MkDocs.
Evidências editoriais testadas
Caminhos de instalação testados para Material e MkDocs padrão
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.
- Autor técnico
- Equipe de documentação da ChattyBox
- Revisor técnico
- Engenharia da ChattyBox
- Última atualização
- Informações verificadas
- MkDocs, Material for MkDocs e mike
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 duplicatas | 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. Refaça o rastreamento após mover um alias e exclua versões sem suporte quando respostas entre versões puderem induzir os usuários ao 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. |
Verificação de resposta com citação
Teste uma resposta na versão ativa
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.
Pergunte aos guias do MkDocs
xComo adiciono o widget sem prejudicar a pesquisa do Material?
Defina theme.custom_dir como overrides, crie overrides/main.html, estenda base.html e adicione o carregador assíncrono dentro do bloco scripts após super(). Chamar super() preserva os scripts usados pelo Material para pesquisa e navegação.
Faça uma pergunta...
Distribuído por ChattyBox
Fontes primárias e evidências reproduzíveis
Personalização do Material for MkDocsOrientação oficial sobre custom_dir, herança de templates e substituição de blocos.Navegação instantânea do MaterialComportamento oficial para substituição do documento sem recarregar a página inteira.Personalização do tema do MkDocsOrientação oficial sobre o diretório de tema personalizado, o template base e super() para o MkDocs padrão.Documentação versionada com mikeImplantação de versões, aliases, versão padrão e testes locais com várias versões.Exemplos executáveis de MkDocsExemplos de Material e MkDocs vanilla com substituições de tema, páginas de teste e os atributos atuais do widget.
Caminho de instalação
Como adicionar o widget ao MkDocs
Para 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 padrão precisa de seu próprio diretório de tema personalizado e substituição equivalente em main.html.
- 1Crie um projeto ChattyBox e insira o URL ou mapa do site do MkDocs ou Material for MkDocs.
- 2Teste perguntas reais do MkDocs no painel e confirme se as citações apontam para as páginas certas.
- 3Adicione a substituição testada, compile o site e verifique pesquisa, navegação, CSP e comportamento em dispositivos móveis.
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 %}Explore a seguir
Mais formas de usar ChattyBox
01Chatbot de IA para documentaçãoConsulte o fluxo de trabalho do chatbot da documentação citada na fonte que se aplica a todas as plataformas.02API chatbot de documentaçãoResponda perguntas sobre endpoint, parâmetro e autenticação de documentos de referência do Python e API.03Bot de bate-papo com IA do DocusaurusCompare o mesmo fluxo de trabalho básico para sites de documentação do Docusaurus.04Navegue por todos os guias da plataformaEncontre guias de configuração para Docusaurus, VitePress, Starlight, Nextra, Mintlify, ReadMe e mais plataformas de documentos.
Perguntas frequentes
Perguntas comuns
1
ChattyBox funciona com Material for MkDocs?
Sim. ChattyBox pode rastrear páginas públicas MkDocs e Material for MkDocs e incorporar como um widget de site padrão.
2
Preciso alterar meu pipeline de construção do Python?
Não. Adicione o snippet do widget ao modelo do seu site ou à substituição do tema após configurar o chatbot.
3
O bot pode responder a partir de documentos versionados?
Sim, se as páginas de documentos com versão forem públicas e incluídas no rastreamento ou no mapa do site.
4
Ele consegue identificar lacunas na documentação?
Sim. A análise de ChattyBox ajuda a revelar perguntas que seu conteúdo MkDocs ainda não responde com clareza.
Cadastre-se para testar nosso plano Free
Está avaliando o ChattyBox para uma organização? Entre em contato com o suporte para conversar sobre um período de teste de um plano mais completo.