メインコンテンツへスキップ
バージョン: 安定版 (v4.x)

DocSearch プログラム

非公式ベータ版翻訳

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

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

DocSearch x Algolia Crawler に関する質問は、Crawler FAQ をご参照ください。

必要なインストール作業は？​

アプリケーションのデプロイ時にメールで届いた認証情報を使って、フロントエンドに DocSearch を実装 するだけでOKです。

DocSearch は Algolia Crawler を活用しており、Web インターフェース からクローラーの作成・監視・編集・起動が可能です。ご質問があれば Crawler FAQ をご覧ください。

費用は？​

無料です！

検索インフラの費用負担はオープンソースプロジェクトにとって課題であるため、DocSearch は誰でも無料で利用できます。代わりにお願いしているのは、検索結果横に「Search by Algolia」ロゴを表示し続けていただくことだけです。

これが難しい場合は、独自の Algolia アカウントを作成 し、この制限なしで 独自に DocSearch を運用 できます。ただしこの場合、ドキュメントの規模によっては有料アカウントが必要になる可能性があります（無料アカウントは最大10,000レコードまで）。

収集するデータは？​

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

ウェブサイト所有者には、独自の Algolia アプリケーションへのアクセス権も付与します。これにより、Algolia でのインデックス状況の確認、ウェブサイト内の匿名化された検索に関する詳細分析、チーム管理などが可能になります！

データの保存場所は？​

DocSearch データは Algolia のサーバーに保存され、世界中にレプリケーションされます。詳細なサーバー仕様はこちら で、完全な情報は プライバシーポリシー をご覧ください。

DocSearch アプリのアップグレード方法は？​

目的に応じて選択肢があります！

アップグレード #1: 既存のDocSearchアプリにRulesなどの特定機能を追加したい​

サポートまでご連絡 ください。対応可能な場合があります。

アップグレード #2: Algoliaロゴを削除したい​

これにより無料DocSearchプログラムの対象外となります。代替として、オープンソースの旧バージョン をセルフホストで利用するか、APIクライアント を使用できます。ただしこの場合、新しいAlgoliaアプリケーションが必要で、使用量に応じた費用が発生します（無料アカウントは最大10,000レコード）。

アップグレード #3: Algoliaが素晴らしいのでサイト全体で使いたい​

素晴らしい！セールスチームまでお問い合わせください。適切なプランの選択をお手伝いします。新しいアプリケーションを作成したら、Crawler設定を新しいアプリケーションのCrawlerにコピー＆ペーストするだけです。

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

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

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

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

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

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

喜んでご協力します！

お気に入りのツールドキュメントサイトがDocSearchを導入していない場合、そのリポジトリにDocSearchの有用性を説明するIssueを立てることをお勧めします。Discordでもお知らせいただければ可能な限り支援します。

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

Docusaurus v2で構築しました。多くのインスピレーションを与えてくれたEndiという人物に支えられました。DocSearchプロジェクトに永遠に刻まれるこの特別な人物に敬意を表します。安らかに。

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

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

メールのAPIキーがダッシュボードと異なるのはなぜ？​

Algoliaアプリにはデフォルトの「Search API Key」が付属しており、これはダッシュボードで確認できます。このキーではアプリケーションが所有するすべてのインデックスをリスト/設定/検索できます。DocSearchアプリケーションでは、承認メールにDocSearchインデックス限定の検索専用APIキーをお送りしています。メールのAPIキーを再取得する必要がある場合はサポートチームへご連絡ください。

APIキーのローテーション方法​

サポートチームまでお問い合わせください。

同じAlgoliaアプリで複数プロジェクトを管理できますか？​

プロジェクトごとに1つのAlgoliaアプリケーションを利用することをお勧めします。他のプロジェクトでDocSearchを使用したい場合は、申請してください。

理由​

初期申請プロジェクトの情報はアプリデプロイ時に全域で使用されます：

  • APIキーのスコープ

  • Algoliaアプリケーション/Crawlerの名称

  • 生成されるインデックス

  • Crawlerの許可ドメイン

これにより、サポートに問い合わせる際の問題範囲を容易に特定できます。

サポート​

注意

サポートに問い合わせる前に必ずドキュメントをお読みください

参考リンク一覧:

Algoliaについてさらに理解を深めるには Algolia Academy もご覧ください。

AlgoliaはDocSearch自体のサポートは提供していませんが、以下の製品に関するお問い合わせには対応可能です:

DocSearch UIライブラリに関する問題は、GitHub Issues でご報告ください。