Intégrer dans votre produit

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

Le Docs Embed est une fenêtre puissante sur les connaissances 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 directement votre documentation, sans quitter votre produit. Vous pouvez ouvrir l’Embed avec un bouton, l’intégrer dans n’importe quel composant de votre choix, ou le contrôler entièrement de manière programmatique.

Intégrez votre documentation à votre produit ou site web

Vue d’ensemble

Le Docs Embed se compose de plusieurs onglets qui s’affichent automatiquement, selon 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

• Documentation : 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 via 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 & MCP → Embed).

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

2

Mise en œuvre

Utilisez notre assistant pour intégrer rapidement GitBook Assistant à votre produit en utilisant votre pile existante.

10KB

GITBOOK_ASSISTANT_SKILL.md

Ouvrir

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

Balise de script autonome

Ajoutez 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 compilation

Composant React

Utilisez des composants React prêts à l’emploi pour une intégration fluide

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 – Ajoutez des messages de bienvenue, des actions personnalisées et des suggestions

• Création d’outils personnalisés – Connectez Assistant aux API de votre produit

Pour aller plus loin

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