製品に埋め込む

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

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

ドキュメントを製品やウェブサイトに埋め込みましょう

概要

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

• アシスタント： GitBook Assistant — ユーザーが答えを見つけるのを支援する、AI 搭載のチャットインターフェース
• 検索：ページをすばやく見つけたり、対象を絞った質問をしたりするための検索中心の画面
• ドキュメント：ドキュメントサイトを移動するためのブラウザー

すべてのタブはデフォルトで有効です。もし タブ、埋め込みには指定したタブのみが表示されます。

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

始めましょう

1

前提条件

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

1. ドキュメントが公開されていること かつ、URL からアクセス可能であること（例: https://docs.company.com).
2. 埋め込みスクリプトの URL を取得していること サイト設定（Settings → AI & MCP → Embed）から。

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

2

実装

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

GITBOOK_ASSISTANT_SKILL.md

10KB

開く

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

スタンドアロンの script タグ

<script> タグを追加するだけで最速でセットアップでき、その後に見た目をカスタマイズできます

Node.js/NPM

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

React コンポーネント

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

ドキュメントで 認証済みアクセスを使用している場合は、 認証済みドキュメントで埋め込みを設定する方法の手順に従ってください.

3

設定

• 埋め込みのカスタマイズ – ウェルカムメッセージ、カスタムアクション、提案を追加する
• カスタムツールの作成 – アシスタントを製品の API に接続する

さらに読む

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