メインコンテンツへスキップ
バージョン: レガシー (v1.x - v2.x)

よくある質問

非公式ベータ版翻訳

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

このウェブサイトで質問の答えが見つからない場合、このページがお役に立ちます。それでも不明な点があれば、Discordでお問い合わせいただくか、サポートチームまでお知らせください。

収集するデータは？​

ウェブサイトのマークアップから抽出したデータを HTML ではなくカスタム JSON 形式で保存します。これが Algolia DocSearch インデックスに登録されるデータです。設定のセレクターでスクレイピングするデータを定義します。

データの保存場所は？​

DocSearchデータはAlgoliaのサーバーでホストされ、世界中にレプリケーションされています。詳細なサーバー仕様はこちらで、より包括的な情報はプライバシーポリシーをご覧ください。

ドキュメント以外のページでDocSearchを使用できますか？​

無料のDocSearchはオープンソースのドキュメントプロジェクトページや技術ブログをクロールします。他のページで使用するには、独自のAlgoliaアカウントを作成し、次のいずれかを実行する必要があります：

コードサンプルをインデックス化できますか？​

可能ですが推奨しません。

コードサンプルは特定のメソッドの使用方法を理解するのに有効ですが、定型コードが繰り返されることが多く検索結果にノイズが生じます。

代わりに、コードブロックをインデックスから除外することをお勧めします（設定のselectors_excludeオプションを使用）。その代わりに、メソッド名がヘッダーに含まれるようにコンテンツを構成してください。

検索結果に重複コンテンツが表示されるのはなぜ？​

これは、複数のURLが同じコンテンツを指している場合に発生します（例：./docs、./docs/、./docs/index.html）。

除外したいパターンをstop_urlsに設定します。次の例は、/またはindex.htmlで終わるすべてのURLを除外します：

{
  "stop_urls": ["/$", "/index.html$"]
}

Algoliaダッシュボードの変更が反映されないのはなぜ？​

何らかの理由でダッシュボードから設定を変更したい場合もあるでしょう。

正常なクロール実行ごとにDocSearch設定が適用され、次のクロールで上書きされます。ダッシュボードからの編集は推奨しません。これらの変更はJSON設定自体から行われます。

この目的には、custom_settingsパラメータを利用できます。

気に入ったドキュメントサイトがDocSearchを採用していません。どうすれば？​

喜んでご協力します！

お気に入りのツールのドキュメントサイトでDocSearchが利用されていない場合、そのリポジトリにDocSearchの有用性を説明したIssueを提出することをお勧めします。メールでのお問い合わせも歓迎します。可能な限りサポートいたします。

DocSearchクロールは何件のレコードを作成しますか？​

設定内のnb_hitsプロパティは、前回のDocSearch実行で抽出・インデックス化されたレコード数を追跡します。クロールはこの数値を自動的に更新します。

DocSearchスクレイパーは推奨されるアトミック再インデックス戦略に従います。ウェブサイトからスクレイピングしたデータを格納する新しい一時インデックスを作成し、成功時に設定のindex_nameキーで定義された古いインデックスを上書きします。

ページがインデックス化されないのはなぜ？​

設定に従ってウェブサイトをスクレイピングしていますが、検索結果からページが欠落することがあります。考えられる原因：

このウェブサイトはどう構築しましたか？​

このサイトはDocusaurus v2で構築しました。多くのインスピレーションを与えてくれた偉大な人物Endiの助力を得ました。DocSearchプロジェクトに永遠に貢献するこの非凡な人物に敬意を表します。安らかに眠れ、同志よ！

v3のリリーススケジュールは？​

Docusaurus 2でv3をプレリリース中です。これにより迅速な反復が可能になり、標準版リリース準備が整います。移行ガイドを提供し、この新バージョンへの移行を支援します。詳細についてはこのトピックに関する検討会をご覧ください。

リポジトリでapiKeyを共有しても安全ですか？​

DocSearchチームが提供するapiKeyは検索専用キーであり、公開しても安全です。バージョン管理システム（例：Git）で追跡可能です。自身でスクレイパーを実行する場合は、必ず検索専用キーを作成し、管理用キーは共有しないでください。