Docusaurus アダプター（推奨）

非公式ベータ版翻訳

このページは PageTurner AI で翻訳されました（ベータ版）。プロジェクト公式の承認はありません。 エラーを見つけましたか？ 問題を報告 →

Docusaurus を使用している場合、@docsearch/docusaurus-adapter をインストール・設定することで、現在の Docusaurus バージョンで最新の DocSearch 機能を利用できます。

このアダプターが存在する理由

Docusaurus には優れた組み込みの Algolia 統合 (@docusaurus/theme-search-algolia) が付属していますが、Docusaurus（Meta 管理）と DocSearch のリリースサイクルは必ずしも同期していません。

DocSearch アダプターを使用することで、Docusaurus 統合の更新を待つことなく、新しい DocSearch 機能（Ask AI サイドパネルサポートを含む）を提供できます。

具体的には以下の利点があります：

• 新しい DocSearch 機能への迅速なアクセス

• Ask AI + サイドパネル機能の互換性向上

• DocSearch プロジェクトでメンテナンスされる専用検索統合パス

インストール

yarn add @docsearch/docusaurus-adapter
# or
npm install @docsearch/docusaurus-adapter

設定

@docusaurus/preset-classic を維持したまま、アダプタープラグインを追加し、検索設定を themeConfig.docsearch に記述します（推奨方法）：

docusaurus.config.mjs

export default {
  plugins: ['@docsearch/docusaurus-adapter'],
  themeConfig: {
    docsearch: {
      appId: 'YOUR_APP_ID',
      apiKey: 'YOUR_SEARCH_API_KEY',
      indexName: 'YOUR_INDEX_NAME',
      askAi: {
        assistantId: 'YOUR_ASSISTANT_ID',
        sidePanel: true,
      },
      contextualSearch: true,
    },
  },
};

docsearch キーと algolia キーの違い

• themeConfig.docsearch が正式な設定キーです

• themeConfig.algolia は後方互換性のためのエイリアスとしてサポートされています

• 両方のキーを同時に定義しないでください

themeConfig.docsearch を使用すると、askAi.sidePanel のような新しい DocSearch オプションを設定する際に、組み込みの Docusaurus 検索テーマバリデーションとの競合を回避できます

検索 UI のカスタマイズ（SearchBar/SearchPage）

検索動作や UI をカスタマイズする場合、アダプター統合パスから提供されるテーマコンポーネント (@theme/SearchBar および @theme/SearchPage) をカスタマイズしてください

これにより、カスタマイズが DocSearch の機能更新と整合性を保ち、組み込みの Docusaurus Algolia テーマ実装との結合を回避できます