Intégrer dans votre produit

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

Le Docs Embed est une fenêtre puissante sur les connaissances produit que vous pouvez ajouter à n'importe quel produit ou site web. Les utilisateurs peuvent poser leurs questions au GitBook Assistant ou parcourir directement votre documentation, sans quitter votre produit. Vous pouvez ouvrir l'Embed avec un bouton, le placer dans n'importe quel composant souhaité, ou le contrôler entièrement de manière programmatique.

Intégrez votre documentation dans votre produit ou site web

Aperçu

Le Docs Embed se compose de plusieurs onglets qui s'affichent automatiquement, en fonction de la configuration de votre site :

• Assistant: Le GitBook Assistant - une interface de chat alimentée par 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 votre documentation, assurez-vous :

1. Votre documentation est publiée et accessible à une URL (par exemple, https://docs.company.com).

2. Vous avez récupéré l'URL du script d'embed depuis les paramètres de votre site (Settings → AI & MCP → Embed).

Si vous souhaitez utiliser l'onglet Assistant, GitBook Assistant doit être activé pour votre site de documentation (Settings → AI & MCP).

2

Implémentation

Choisissez l'approche qui correspond à votre configuration :

Balise de script autonome

Insérez une balise <script> pour la configuration 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 construction

Composant React

Utilisez des composants React préconstruits pour une intégration transparente

Si votre documentation utilise Accès authentifié, suivez les étapes dans comment configurer l'embed avec une documentation authentifiée.

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.