Bot de support MkDocs

Chatbot IA MkDocs pour Documentation MkDocs

Utilisez ChattyBox pour rendre votre contenu MkDocs consultable via un widget conversationnel qui reste ancré dans vos pages sources.

Analyse les pages de documents publiées

Réponses citées par la source

S'intègre avec un seul script

Aucune migration de documents requise

Créez gratuitement un chatbot IA MkDocs Lire le guide de configuration

Aucune carte de crédit requiseVotre contenu reste à vous

Demander à ChattyBox

Par où commencer si j’ai besoin d’une réponse fiable depuis ce site ?

Commencez par ajouter l’URL de votre site web à ChattyBox. Il explore votre contenu, répond à partir des pages trouvées et montre aux visiteurs les sources derrière chaque réponse.

iSources citées3^

MkDocs Guide

chattybox.ai

Statistiques

chattybox.ai

Accueil

chattybox.ai

Posez une question...

Propulsé par ChattyBox

Conçu pour les équipes MkDocs

Lancez un chatbot avec citations de sources sans reconstruire votre stack de docs

ChattyBox explore votre documentation existante, indexe le contenu pour la recherche et intègre un chatbot qui répond avec vos docs plutôt qu’avec la mémoire générique du modèle.

La surcharge Material conserve le JavaScript du thème et ajoute un seul chargeur asynchrone pour le widget.

MkDocs standard utilise un répertoire de thème personnalisé distinct au lieu de supposer l'existence des chemins Material.

Les vérifications couvrent la coexistence avec la recherche, la navigation instantanée, les chargeurs en double et les fenêtres mobiles étroites.

La sélection de l'exploration selon les versions permet de choisir délibérément les routes mike stables, les plus récentes et héritées.

Étape du workflow

Explorez le plan de site MkDocs déployé ou les chemins stables et versionnés que vous prenez délibérément en charge.

Étape du workflow

Testez des questions sur le produit, Python et l'API, puis ouvrez chaque citation avant l'installation.

Étape du workflow

Pour Material, configurez theme.custom_dir et étendez base.html depuis overrides/main.html tout en conservant le bloc scripts avec super().

Étape du workflow

Vérifiez la recherche intégrée, la navigation instantanée, les contrôles mobiles, la CSP et chaque version publiée avec mike.

Un lancement en trois étapes

Collez votre URL MkDocs, testez les réponses citées, puis installez le widget.

Créez gratuitement un chatbot IA MkDocs

Flux de travail spécifique à MkDocs

Prise en charge conversationnelle des sites de documentation Python statiques

Les équipes MkDocs souhaitent généralement des versions statiques rapides, une navigation claire et un contenu technique lisible. ChattyBox conserve ce flux de travail intact tout en ajoutant un assistant cité par la source au-dessus du site publié.

Chemin de décision

Utilisez ces points de contrôle pour décider si ChattyBox doit s'asseoir à côté de votre plate-forme de documents, remplacer un assistant distinct ou rester isolé pour les tests.

Fonctionne avec les pages Material for MkDocs

Indexez les guides, les pages de référence et le HTML statique généré à partir des déploiements publics MkDocs ou Material for MkDocs sans remplacer votre thème.

Gérer délibérément la documentation versionnée

Pointez ChattyBox sur les chemins de version sur lesquels vous souhaitez que les utilisateurs posent des questions, puis testez si les réponses citent les documents stables, les plus récents ou les anciens prévus.

Aucun travail d'indexation Python à maintenir

Étant donné que ChattyBox explore le site public, les équipes n'ont pas besoin d'ajouter une indexation vectorielle à leur pipeline de génération MkDocs ou à leurs scripts CI.

Améliorer les documents à partir de vraies questions

Utilisez des questions sans réponse pour identifier les exemples manquants, les étapes d'installation peu claires ou les pages de dépannage obsolètes dans votre site MkDocs.

Éléments éditoriaux vérifiés

Méthodes d'installation testées pour Material et MkDocs standard

Material for MkDocs et le thème MkDocs intégré prennent tous deux en charge l'héritage de modèles, mais doivent utiliser des répertoires personnalisés distincts. La méthode Material ci-dessous conserve son bloc scripts avec super(), ajoute un seul chargeur asynchrone et résiste à la navigation instantanée sans remplacer le comportement de recherche.

Auteur technique: Équipe de documentation ChattyBox
Réviseur technique: Équipe d'ingénierie ChattyBox
Dernière mise à jour: 9 juillet 2026
Informations vérifiées: MkDocs, Material for MkDocs et mike

Vérifiez de nouveau les blocs de modèles et le comportement de la navigation instantanée après les mises à niveau du thème, et relancez l'exploration chaque fois qu'un alias mike est déplacé.

Configuration de custom_dir pour Material for MkDocs et surcharge du modèle principal conservant les scripts du thème — Référence d'installation originale : theme.custom_dir sélectionne la surcharge et super() conserve intacts les scripts de recherche et de navigation de Material.

Décisions d'installation pour Material et MkDocs standard, avec vérifications de bout en bout.
Point d'attention pour MkDocs	Décision d'implémentation	Vérification
Surcharge de Material	Définissez theme.name sur material et theme.custom_dir sur overrides. Étendez base.html, surchargez scripts, appelez super(), puis ajoutez le script du widget.	Compilez et servez le site, puis vérifiez que la recherche et la navigation de Material fonctionnent toujours.
MkDocs standard	Utilisez theme.name: mkdocs avec un répertoire custom_theme distinct. Ajoutez la surcharge équivalente dans custom_theme/main.html au lieu de copier les modèles Material.	Exécutez mkdocs serve et vérifiez la recherche, les liens suivant et précédent, ainsi que le widget sur plusieurs pages.
Chargement asynchrone et doublons	Conservez un seul chargeur dans le bloc scripts hérité, attribuez-lui un ID stable et n'ajoutez pas le même extrait via extra_javascript ou un autre modèle partiel.	Après les chargements complets et les transitions instantanées de Material, vérifiez que document.querySelectorAll("#chattybox-widget").length vaut 1.
Politique de sécurité du contenu	Autorisez chattybox.ai dans script-src, l'origine de l'API configurée dans connect-src, fonts.googleapis.com dans style-src et fonts.gstatic.com dans font-src. Le widget actuel injectant son propre CSS de composant, un style-src strict nécessite également 'unsafe-inline' jusqu'à ce qu'une gestion par nonce ou une feuille de styles externe soit disponible.	Recherchez dans la console du navigateur et le panneau Network les requêtes de script, de style, de police, fetch ou WebSocket bloquées.
Recherche, navigation instantanée et mobile	Conservez les scripts du thème avec super() et veillez à ce que le lanceur ne chevauche ni la boîte de dialogue de recherche, ni le tiroir, ni la pagination, ni les contrôles de consentement.	Testez la recherche au clavier, plusieurs liens instantanés et une fenêtre de 390 pixels, sans chevauchement ni défilement horizontal.
Versions mike	Choisissez délibérément les chemins stable, latest ou d'une version explicite. Relancez l'exploration après le déplacement d'un alias et excluez les versions non prises en charge lorsque des réponses provenant d'autres versions induiraient les utilisateurs en erreur.	Utilisez mike serve pour tester le changement de version et vérifier que les citations aboutissent dans la version prévue.
Dysfonctionnement du widget ou des citations	Vérifiez l'indentation YAML, le custom_dir actif, le nom du bloc hérité, la clé d'API, la CSP, le contenu du plan de site et la présence de la surcharge dans la version déployée.	Examinez le HTML généré et testez l'artefact de production au lieu de vous fier uniquement au rechargement en direct.

Vérification d'une réponse avec citations

Tester une réponse avec la version active

Utilisez une question sur le thème assortie d'une règle de modèle vérifiable, puis ouvrez la citation et confirmez qu'elle correspond à la version sélectionnée par votre visiteur.

Interroger les guides MkDocs

Comment ajouter le widget sans perturber la recherche de Material ?

Définissez theme.custom_dir sur overrides, créez overrides/main.html, étendez base.html et ajoutez le chargeur asynchrone dans le bloc scripts après super(). L'appel de super() conserve les scripts que Material utilise pour la recherche et la navigation.

iSources citées2^

Material : personnalisation

squidfunk.github.io/mkdocs-material

MkDocs : personnaliser votre thème

mkdocs.org/user-guide

Posez une question...

Propulsé par ChattyBox

Référence mobile originale : la recherche reste disponible, le lanceur offre une cible tactile utilisable et la page ne défile pas horizontalement.

Sources primaires et éléments reproductibles

Personnalisation de Material for MkDocsInstructions officielles sur custom_dir, l'héritage de modèles et la surcharge de blocs.Navigation instantanée de MaterialComportement officiel du remplacement de document sans rechargement complet de la page.Personnalisation du thème MkDocsInstructions officielles sur le répertoire de thème personnalisé, le modèle de base et super() pour MkDocs standard.Documentation versionnée avec mikeDéploiement des versions, alias, version par défaut et tests locaux multiversions.Exemples MkDocs reproductiblesProjets Material et standard distincts avec des surcharges de modèles testées.

Parcours d’installation

Comment ajouter le widget à MkDocs

Pour Material for MkDocs, définissez theme.custom_dir sur overrides, étendez base.html dans overrides/main.html et appelez super() avant le script asynchrone du widget. MkDocs standard nécessite son propre répertoire de thème personnalisé et une surcharge main.html équivalente.

1Créez un projet ChattyBox et entrez l'URL ou le plan du site de votre site MkDocs ou Material for MkDocs.
2Testez de vraies questions MkDocs dans le tableau de bord et confirmez que les citations pointent vers les bonnes pages.
3Ajoutez la surcharge testée, compilez le site et vérifiez la recherche, la navigation, la CSP et le comportement sur mobile.

Créez gratuitement un chatbot IA MkDocs

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

À explorer ensuite

Plus de façons d’utiliser ChattyBox

Explorer toutes les solutions

Chatbot IA pour la documentation

Consultez le workflow de chatbot de la documentation citée par la source qui s'applique à toutes les plateformes.

Ouvrir

Chatbot de documentation API

Répondez aux questions sur les points de terminaison, les paramètres et l'authentification des documents de référence Python et API.

Ouvrir

Chatbot IA Docusaurus

Comparez le même flux de travail pour les sites de documentation Docusaurus.

Ouvrir

Parcourez tous les guides de la plateforme

Recherchez des guides de configuration pour Docusaurus, VitePress, Starlight, Nextra, Mintlify, ReadMe et d'autres plates-formes de documentation.

Ouvrir

Questions fréquentes

ChattyBox fonctionne-t-il avec Material for MkDocs ?

Oui. ChattyBox peut explorer des pages publiques MkDocs et Material for MkDocs et s’intégrer comme un widget web standard.

Dois-je modifier mon pipeline de build Python ?

Non. Ajoutez l’extrait du widget à votre modèle de site ou à la surcharge de thème après avoir configuré le chatbot.

Le bot peut-il répondre à partir de docs versionnées ?

Oui, si les pages de docs versionnées sont publiques et incluses dans l’exploration ou le sitemap.

Peut-il identifier les lacunes de documentation ?

Oui. Les analytics de ChattyBox aident à révéler les questions auxquelles votre contenu MkDocs ne répond pas encore clairement.

Commencer gratuitement

Aucune carte de crédit requise. Votre contenu n’est pas utilisé pour l’entraînement de modèles.

Créer un chatbot gratuit

Niveau Free. Aucune carte requise.