Intégrer dans votre produit

Intégrez votre documentation dans votre produit ou votre site web à l’aide de Docs Embed.

L’intégration Docs est une fenêtre puissante sur la connaissance de votre produit que vous pouvez ajouter à n’importe quel produit ou site web. Les utilisateurs peuvent poser des questions à GitBook Assistant, rechercher dans vos docs ou parcourir directement les pages, sans quitter votre produit. Vous pouvez ouvrir l’intégration avec un bouton, l’intégrer dans n’importe quel composant de votre choix ou la contrôler entièrement par programmation.

Intégrez votre documentation dans votre produit ou site web

Vue d’ensemble

L’intégration Docs peut contenir trois onglets :

• Assistant: L’ GitBook Assistant - une interface de chat alimentée par l’IA pour aider les utilisateurs à trouver des réponses
• Recherche: une interface axée sur la recherche pour trouver rapidement des pages et poser des questions ciblées
• Docs: un navigateur pour parcourir votre site de documentation

Tous les onglets sont activés par défaut. Si vous définissez onglets, l’intégration n’affiche que les onglets que vous listez.

Vous pouvez personnaliser et remplacer la configuration par défaut avec des actions personnalisées, des outils, des questions suggérées, Accès authentifié, et bien plus encore.

Commencer

1

Prérequis

Avant d’intégrer votre documentation, assurez-vous que :

1. Votre documentation est publiée et accessible à une URL (par ex., https://docs.company.com).
2. Vous avez récupéré l’URL du script d’intégration dans les paramètres de votre site (Paramètres → IA et MCP → Intégration).

Si vous souhaitez utiliser l’onglet Assistant, GitBook Assistant doit être activé pour votre site de documentation (Paramètres → IA et MCP).

2

Implémentation

Utilisez notre skill pour intégrer rapidement GitBook Assistant à votre produit à l’aide de votre pile existante.

GITBOOK_ASSISTANT_SKILL.md

10KB

Ouvrir

Sinon, poursuivez votre lecture dans la documentation pour l’approche qui correspond à votre configuration :

Balise script autonome

Ajoutez une balise <script> pour l’installation la plus rapide, puis personnalisez son apparence

Node.js/NPM

Installez via NPM pour le rendu côté serveur ou le contrôle au moment de la compilation

Composant React

Utilisez des composants React préconçus pour une intégration fluide

Si votre documentation utilise Accès authentifié, suivez les étapes de comment configurer l’intégration avec une documentation authentifiée.

3

Configuration

• Personnalisation de l’intégration – Ajoutez des messages de bienvenue, des actions personnalisées et des suggestions
• Créer des outils personnalisés – Connectez Assistant aux API de votre produit

Pour aller plus loin

Pour la référence complète de l’API et le code source, consultez le @gitbook/embed package sur GitHub.