製品への埋め込み

Docs Embedを使ってドキュメントを製品やウェブサイトに埋め込む

Docs Embedは、製品やウェブサイトに追加できる強力な製品知識への窓です。ユーザーは次に質問をすることができます： GitBookアシスタント または製品を離れることなく直接ドキュメントを参照できます。ボタンでEmbedを開いたり、任意のコンポーネントに配置したり、完全にプログラムから制御したりできます。

ドキュメントを製品やウェブサイトに埋め込む

概要

Docs Embedは、サイトの設定に応じて自動的に表示される複数のタブで構成されています：

• アシスタント：次の GitBookアシスタント －ユーザーが答えを見つけるのを支援するAI搭載のチャットインターフェース

• ドキュメント：ドキュメントサイトをナビゲートするブラウザ

カスタムアクション、ツール、推奨質問、 認証されたアクセスなどでデフォルト構成をカスタマイズおよび上書きできます。

はじめに

1

前提条件

ドキュメントを埋め込む前に、次を確認してください：

1. ドキュメントが公開されていること 次のようなURLでアクセス可能であること（例： https://docs.company.com).

2. 埋め込みスクリプトのURLを取得していること サイトの設定（Settings → AI & MCP → Embed）から。

Assistantタブを使用したい場合、 GitBookアシスタントが有効化されている必要があります ドキュメントサイトで（Settings → AI & MCP）。

2

実装

セットアップに合った方法を選んでください：

単体のスクリプトタグ

最速のセットアップとして<script>タグを挿入し、その見た目をカスタマイズします

Node.js/NPM

サーバーサイドレンダリングやビルド時の制御のためにNPM経由でインストールします

Reactコンポーネント

シームレスな統合のために既成のReactコンポーネントを使用します

ドキュメントが 認証されたアクセスを使用している場合は、次の手順に従ってください： 認証されたドキュメントでEmbedを設定する方法.

3

設定

• Embedのカスタマイズ －ウェルカムメッセージ、カスタムアクション、提案を追加します

• カスタムツールの作成 －アシスタントを製品のAPIに接続します

関連記事

完全なAPIリファレンスとソースコードについては、次を参照してください： @gitbook/embed GitHub上のパッケージ.