How to run my own crawler to use the Docsearch plugin?

[Yue-plus]

How to run my own crawler to use the Docsearch plugin?
如何运行自己的爬虫来使用 Docsearch 插件？

---

Symptom description / 症状描述

I added the @vuepress/plugin-docsearch plugin to my VuePress2 project and ran my own crawler by referring to the "Running Your Own Crawler" document.
我在自己的 VuePress2 项目中添加了 @vuepress/plugin-docsearch 插件，并参照”运行你自己的爬虫“ 文档来运行了自己的爬虫。

Now there are records in Indices:
现在 Indices 中已经有 records 了：

But no results are found in VuePress2:
但在 VuePress2 中搜索不到任何结果：

Project link: https://note.yueplus.ink/
项目地址：https://note.yueplus.ink/

---

Operation process / 操作过程

VuePress configuration / VuePress 配置

Add @vuepress/plugin-docsearch plugin:
添加 @vuepress/plugin-docsearch 插件：

yarn add @vuepress/plugin-docsearch@next

package.json:

{
  "devDependencies": {
    "vuepress": "^2.0.0-beta.6"
  },
  "dependencies": {
    "@vuepress/plugin-docsearch": "^2.0.0-beta.6",
  }
}

.vuepress/config.ts:

  plugins: [
    ['@vuepress/docsearch', {
      appId: '0YWM7BGDQI',                     // Application ID
      apiKey: '9dc6fe12516690be51dea370e78001f6',   // Search-Only API Key
      indexName: 'note.yueplus.ink',
      locales: {
        '/': {
          placeholder: '在此搜索文档'
        }
      }
    }]
  ]

Run the crawl from the Docker image / 从 Docker 镜像运行爬虫

docker run --env-file=.env -e "CONFIG=$(cat /c/Users/Yue_plus/code/NetNote/docsearch.config.json | jq -r tostring)" algolia/docsearch-scraper

docsearch.config.json :

{
    "index_name": "note.yueplus.ink",
    "start_urls": ["https://note.yueplus.ink/"],
    "selectors": {
      "lvl0": ".page header h1",
      "lvl1": ".page article h1",
      "lvl2": ".page section h3",
      "lvl3": ".page section h4",
      "lvl4": ".page section h5",
      "lvl5": ".page section h6",
      "text": ".page header p,.page section p,.page section ol,.page ul li"
    }
  }

Maybe my docsearch.config.json file is incorrectly written?
可能是我的 docsearch.config.json 文件写的不正确？

[Yue-plus]

The data can be searched using the playground tool in docsearch-scraper, but the search results are not displayed normally:
使用 docsearch-scraper 中的测试工具是可以搜索到数据的，但是却没有正常显示搜索结果：

[Yue-plus]

Seems like your config is wrong. Do you have .page header h1 element in your site?

I'm using the default theme of VuePress2, can you provide a docsearch.config.json that can be used for the default theme in the documentation?
我正在使用 VuePress2 的默认主题，可否在 文档 中提供一个可用于默认主题的 docsearch.config.json？

[Yue-plus]

When Create a new configuration, I encountered a problem:
参考 创建新配置文件 操作时，遇到问题：

An error was encountered while executing ./docsearch bootstrap. #547

[Yue-plus]

After changing the 'docsearch.config.json' file to the following:
将 docsearch.config.json 文件更改为如下内容后：

{
  "index_name": "note.yueplus.ink",
  "start_urls": [
    "https://note.yueplus.ink/"
  ],
  "stop_urls": [],
  "selectors": {
    "lvl0": "main h1",
    "lvl1": "main h2",
    "lvl2": "main h3",
    "lvl3": "main h4",
    "lvl4": "main h5",
    "lvl5": "main h6",
    "text": "main p, main li"
  }
}

I cleared the Indices once, re-run the crawler, and crawled more records:
清空了一次 Indices，重新运行爬虫，爬取到了更多 records：

The search results can now be displayed normally in the playground tool in docsearch-scraper :
现在能在 docsearch-scraper 中的测试工具中正常展示搜索结果了：

But now I still can’t search in VuePress2:
但现在任然无法在 VuePress2 中搜索：

[meteorlxy]

You can refer to these configs:

• vuepress officail docs (both v1 and v2): https://github.com/algolia/docsearch-configs/blob/a797a5c2b1531174c403eb2ea46a8adefca92e6d/configs/vuepress.json
• vuepress-theme-reco: https://github.com/algolia/docsearch-configs/blob/a797a5c2b1531174c403eb2ea46a8adefca92e6d/configs/vuepress-theme-reco.json
• vuepress-theme-hope: https://github.com/algolia/docsearch-configs/blob/a797a5c2b1531174c403eb2ea46a8adefca92e6d/configs/vuepress-theme-hope.json

Some important parts:

      "lang": {
        "selector": "/html/@lang",
        "type": "xpath",
        "global": true
      }

  "custom_settings": {
    "attributesForFaceting": [
      "lang"
    ]
  },

I'll refine the docs later

[Yue-plus]

docsearch.config.json:

{
  "index_name": "note.yueplus.ink",
  "start_urls": [
    "https://note.yueplus.ink/"
  ],
  "stop_urls": [],
  "selectors": {
    "lvl0": "main h1",
    "lvl1": "main h2",
    "lvl2": "main h3",
    "lvl3": "main h4",
    "lvl4": "main h5",
    "lvl5": "main h6",
    "text": "main p, main li",
    "lang": {
      "selector": "/html/@lang",
      "type": "xpath",
      "global": true
    }
  },
  "custom_settings": {
    "attributesForFaceting": ["lang", "tags"]
  }
}

Oh Yeah!!!
好耶！！！