製品に埋め込む

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

Docs Embed は、製品知識への強力なウィンドウであり、あらゆる製品やウェブサイトに追加できます。ユーザーはに質問できます GitBook Assistantへ、製品から離れることなく、ドキュメントを検索したり、ページを直接閲覧したりできます。埋め込みはボタンで開くことも、任意のコンポーネントに配置することも、完全にプログラムで制御することもできます。

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

概要

Docs Embed には3つのタブを含めることができます:

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

• 検索：ページをすばやく見つけたり、対象を絞った質問をしたりするための検索中心の画面

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

すべてのタブはデフォルトで有効です。 tabsを設定すると、埋め込みにはリストしたタブのみが表示されます。

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

はじめに

1

前提条件

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

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

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

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

2

実装

既存のスタックを使って、GitBook Assistant を製品にすばやく実装するには、当社のスキルを使用してください。

10KB

GITBOOK_ASSISTANT_SKILL.md

開く

または、セットアップに合った方法について、次のドキュメントを読み進めてください:

スタンドアロンの script タグ

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

Node.js/NPM

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

React コンポーネント

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

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

3

設定

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

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

さらに読む

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