メインコンテンツにスキップ

Algolia DocSearch 設定ガイド

はじめに​

Algolia DocSearch は強力な書類検索サービスで、高度な検索をサポートできる強力な検索機能を提供します。このガイドではDocusaurusサイトのAlgolia 検索に協力できます。

ステップ1: Algolia アカウント登録​

  1. アクセスするAlgolia Network にアクセスしてサインアップする
  2. ログイン後、新しいアプリケーション (Application) を作成
  3. アプリケーションIDの下に自分のアプリケーションIDを作成する

ステップ2: DocSearch 爬虫や翼を設定する​

オプションA: DocSearch 爬虫類 (推奨)​

  1. サイトにアクセスする DocSearch 申請
  2. フォームに必要事項です。サイトの URL とサイトの URL が必要です。
  3. 依頼を提出した後 Algolia チームは申請を検証します
  4. 承認された場合は、設定に関するメールを受信します。

B: 爬虫類を設定​

よじ虫を管理したい場合、次のステップに従って：

  1. 2DoCSearch Crafting： のインストール

    npm install @docsearch/scraper

  2. 创建配置文件 docsearch.config.json：

    {
  "index_name": "你的索引名称",
  "start_urls": ["https://你的网站域名/"],
  "sitemap_urls": ["https://你的网站域名/sitemap.xml"],
  "sitemap_alternate_links": true,
  "stop_urls": [],
  "selectors": {
    "lvl0": {
      "selector": ".menu__link--sublist.menu__link--active",
      "global": true,
      "default_value": "Documentation"
    },
    "lvl1": "article h1",
    "lvl2": "article h2",
    "lvl3": "article h3",
    "lvl4": "article h4",
    "lvl5": "article h5, article td:first-child",
    "text": "article p, article li, article td:last-child"
  },
  "strip_chars": " .,;:#",
  "custom_settings": {
    "separatorsToIndex": "_",
    "attributesForFaceting": ["language", "version", "type", "docusaurus_tag"],
    "attributesToRetrieve": ["hierarchy", "content", "anchor", "url", "url_without_anchor", "type"]
  }
}

  3. Algolia コントロールパネルのに API キー： を作成

    • APIキーページに移動
    • 创建一个新的 API 密钥，具有以下权限：
      • search
      • addObject
      • deleteObject
      • deleteIndex
      • settings
      • editSettings

  4. 爬虫： で遊ぶ

    docker run -it --env-file=.env -e "CONFIG=$(cat docsearch.config.json | jq -r tostring" algolia/docsearper -craper

    其中 .env 文件包含：

    APPLICATION_ID=あなたのアプリケーションID
API_KEY=あなたの管理APIキー

ステップ3: Docusaurus設定​

  1. 安装 Algolia 搜索主题：

    npm install --save @docusaurus/theme-sesearch-algolia

  2. docusaurus.config.tsにAlgolia： を設定します

    // Docusaurus.config.ts
export default {
  // ...
  themeConfig: {
    // ...
    algolia: {
      appId: 'アプリID' // あなたの Algolia アプリ ID
      apiKey: 「API キー」を検索する // あなたの API キー（API キー）を検索します
      indexName: 'あなたのインデックス名', // あなたのインデックス名
      contextualSearch: true, // コンテキスト検索有効
      // 必要に応じて
      searchParameters: {} // 検索結果の詳細設定
      searchPagePath: 'search' // 検索ページパス
    },
    //：Algolia を有効にします。 メモまたはローカル検索から
    // search: {
    // provider: require. esolve('@easyops-cn/docusaurus-search-local'),
    // ...
    // },
  },
};

  3. 重启开发服务器：

    npm run start

ステップ 4: 検索を検証する​

  1. あなたのサイト訪問
  2. ナビゲーションバーの検索アイコンをタップしてください
  3. 検索キーワードを入力してください
  4. 検索結果が正しいことを確認してください

よくある質問​

検索結果が空です​

  • 爬虫類がうまく作動し、サイトをインデックスしました
  • Algolia コントロールパネルのインデックスにデータが含まれているかどうかをチェックします。
  • API キーを apiKey が新しい API キーかどうかを確認します。

依存関係の競合​

如果安装 @docusaurus/theme-search-algolia 时出现依赖冲突，可以尝试：

# 使用 --legacy-peer-deps 选项
npm install --save @docusaurus/theme-search-algolia --legacy-peer-deps

# 或使用 --force 选项
npm install --save @docusaurus/theme-search-algolia --force

ローカル検索はAlgolia Networkの中​

2つの検索を推奨しません、代わりにその：

  • Algoliaを使用したい場合は、タイトルとローカルの検索の設定を削除してください
  • ローカルの検索を使用している場合は、注釈を使用するか、Algolia の設定を削除してください。

リソースリンク​