Intégrer dans votre produit

Intégrez votre documentation dans votre produit ou site web en utilisant l'Embed Docs.

Le Docs Embed 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 leurs questions au Assistant GitBook ou parcourir vos docs directement, sans quitter votre produit. Vous pouvez ouvrir l'Embed avec un bouton, le placer dans n'importe quel composant que vous souhaitez, ou le contrôler complètement de manière programmatique.

Intégrez vos docs dans votre produit ou site web

Aperçu

Le Docs Embed est composé de plusieurs onglets qui s'affichent automatiquement, en fonction de la configuration de votre site :

• Assistant: Le Assistant GitBook - une interface de chat alimentée par l'IA pour aider les utilisateurs à trouver des réponses

• Docs: Un navigateur pour parcourir votre site de documentation

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 plus encore.

Commencer

1

Prérequis

Avant d'intégrer vos docs, assurez-vous :

1. Vos docs sont publiés et accessibles à une URL (par exemple, https://docs.company.com).

2. Vous avez récupéré l'URL du script d'intégration depuis les paramètres de votre site (Paramètres → IA & MCP → Embed).

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

2

Implémentation

Choisissez l'approche qui correspond à votre configuration :

Balise script autonome

Déposez 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éconstruits pour une intégration transparente

Si vos docs utilisent Accès authentifié, suivez les étapes dans comment configurer l'embed avec des docs authentifiés.

3

Configuration

• Personnalisation de l'Embed – Ajouter des messages de bienvenue, des actions personnalisées et des suggestions

• Création d'outils personnalisés – Connecter l'Assistant aux API de votre produit

Lectures complémentaires

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