Intégrer dans votre produit

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

L’Embed Docs 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 des questions à l’ Assistant GitBook, rechercher dans votre documentation ou parcourir directement les pages, 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 नियंत्रler entièrement par programmation.

Intégrez votre documentation dans votre produit ou site web

Vue d’ensemble

L’Embed Docs peut contenir trois onglets :

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

• Recherche : Une interface centré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’embed n’affiche que les onglets que vous avez सूचीés.

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 que :

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 depuis les paramètres de votre site (Paramètres → IA & MCP → Embed).

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

2

Implémentation

Utilisez notre solution pour intégrer rapidement GitBook Assistant dans votre produit en utilisant votre stack existante.

10KB

GITBOOK_ASSISTANT_SKILL.md

Ouvrir

Sinon, continuez à lire 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 du build

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 de 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

Lectures complémentaires

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