製品に埋め込む

Docs Embedを使って、ドキュメントを製品やWebサイトに埋め込みます。

Docs Embed は、製品やウェブサイトに追加できる、製品ナレッジへの強力なウィンドウです。ユーザーは次の相手に質問できます： GitBook Assistant または、製品を離れることなくドキュメントを直接閲覧できます。Embed はボタンで開いたり、任意のコンポーネントに組み込んだり、完全にプログラムで制御したりできます。

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

概要

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

• Assistant： GitBook Assistant - ユーザーが答えを見つけるのを助ける、AI 搭載のチャットインターフェース

• Docs：ドキュメントサイトを移動するためのブラウザー

カスタムアクション、ツール、推奨質問、 認証済みアクセスなどを使って、デフォルト設定をカスタマイズおよび上書きできます。

はじめに

1

前提条件

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

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

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

Assistant タブを使いたい場合は、 GitBook Assistant が有効になっている必要があります ドキュメントサイトで（Settings → AI & MCP）。

2

実装

既存のスタックを使って、当社のスキルを利用し、GitBook Assistant をすばやく製品に実装できます。

10KB

GITBOOK_ASSISTANT_SKILL.md

開く

または、以下の導入方法に合った手順をドキュメントで読み進めてください：

単独の script タグ

最速でセットアップするには <script> タグをそのまま追加し、その後外観をカスタマイズします

Node.js/NPM

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

React コンポーネント

シームレスに統合するために、事前構築済みの React コンポーネントを使用します

ドキュメントが 認証済みアクセスを使用している場合は、 認証済みドキュメントで埋め込みを設定する方法.

3

設定

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

• カスタムツールの作成 – Assistant を製品の API に接続する

さらに読む

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