meilisearch

将 MeiliSearch 集成到 VuePress 中，为你的文档网站提供搜索功能。

使用方法

npm i -D @vuepress/plugin-meilisearch@next

import { meilisearchPlugin } from '@vuepress/plugin-meilisearch'

export default {
  plugins: [
    meilisearchPlugin({
      // 配置项
      host: '',
      apiKey: '',
      indexUid: '',
    }),
  ],
}

在服务器上运行 MeiliSearch

MeiliSearch 提供了一个服务器程序，支持使用云服务器的用户的自部署选项。为了简化在服务器端运行 MeiliSearch 的过程，你可以使用 Docker 进行安装和管理。

docker pull getmeili/meilisearch:latest

在第一次启动时，默认情况下将生成一个主密钥（MASTER_KEY）。不要暴露此密钥；它应该只用于内部服务器访问，因为它拥有完全的操作权限。

docker run -it --rm \
  -p 7700:7700 \
  -v $(pwd)/meili_data:/meili_data \
  getmeili/meilisearch:latest

参考 https://www.meilisearch.com/docs/guides/misc/docker

抓取网站

MeiliSearch 提供了一个 Docker 爬虫来抓取文档。在此之前，保证 MeiliSearch 已经运行。

这是一个爬虫配置的示例，你应该保存、修改并传递给爬虫：

{
  "index_uid": "YOUR_INDEX_NAME",
  "start_urls": ["https://YOUR_WEBSITE_URL/"],
  "sitemap_urls": ["https://YOUR_WEBSITE_URL/sitemap.xml"],
  "selectors": {
    "lvl0": {
      "selector": ".vp-sidebar-heading.active",
      "global": true,
      "default_value": "Documentation"
    },
    "lvl1": "[vp-content] h1",
    "lvl2": "[vp-content] h2",
    "lvl3": "[vp-content] h3",
    "lvl4": "[vp-content] h4",
    "lvl5": "[vp-content] h5",
    "lvl6": "[vp-content] h6",
    "content": "[vp-content] p, [vp-content] li",
    "lang": {
      "selector": "/html/@lang",
      "global": true,
      "type": "xpath"
    }
  },
  "custom_settings": {
    "searchableAttributes": [
      "hierarchy_radio_lvl0",
      "hierarchy_radio_lvl1",
      "hierarchy_radio_lvl2",
      "hierarchy_radio_lvl3",
      "hierarchy_radio_lvl4",
      "hierarchy_radio_lvl5",
      "hierarchy_lvl0",
      "hierarchy_lvl1",
      "hierarchy_lvl2",
      "hierarchy_lvl3",
      "hierarchy_lvl4",
      "hierarchy_lvl5",
      "hierarchy_lvl6",
      "content",
      "lang",
      "objectID",
      "page_rank",
      "level",
      "position"
    ],
    "displayedAttributes": [
      "hierarchy_radio_lvl0",
      "hierarchy_radio_lvl1",
      "hierarchy_radio_lvl2",
      "hierarchy_radio_lvl3",
      "hierarchy_radio_lvl4",
      "hierarchy_radio_lvl5",
      "hierarchy_lvl0",
      "hierarchy_lvl1",
      "hierarchy_lvl2",
      "hierarchy_lvl3",
      "hierarchy_lvl4",
      "hierarchy_lvl5",
      "hierarchy_lvl6",
      "anchor",
      "url",
      "lang",
      "content",
      "objectID"
    ],
    "filterableAttributes": ["lang"]
  }
}

start_urls 和 sitemap_urls（可选）应根据要抓取的网站进行自定义。
selectors 字段可以根据第三方 DOM 结构进行自定义。
你可以根据需要向 custom_settings 添加新字段。

重要

为了让插件工作：

lang 选择器必须在 selectors 字段中保持不变
custom_settings 中当前的所有字段都不能删除。

开始抓取文档，MEILISEARCH_HOST_URL 是运行 MeiliSearch 的主机地址，<MASTER_KEY> 是主密钥，<absolute-path-to-your-config-file> 是抓取配置文件的绝对路径：

docker run -t --rm \
  --network=host \
  -e MEILISEARCH_HOST_URL='<MEILISEARCH_HOST_URL>' \
  -e MEILISEARCH_API_KEY='<MASTER_KEY>' \
  -v <absolute-path-to-your-config-file>:/docs-scraper/config.json \
  getmeili/docs-scraper:latest pipenv run ./docs_scraper config.json

抓取完成后，MeiliSearch 将在指定的索引中存储抓取到的文档。

参考 https://www.meilisearch.com/docs/guides/front_end/search_bar_for_docs#scrape-your-content

获取搜索索引和 API 密钥

要创建只允许搜索操作的访问密钥，请使用以下请求。indexes 数组指定该密钥可以访问哪些索引，expiresAt 设置密钥的过期时间。

curl \
  -X POST 'http://localhost:7700/keys' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <MASTER_KEY>' \
  --data-binary '{
    "description": "Search records key",
    "actions": ["search"],
    "indexes": ["YOUR_INDEX_NAME"],
    "expiresAt": "2025-01-01T00:00:00Z"
  }'

如果成功，响应将如下所示：

{
  "name": null,
  "description": "Search records key",
  "key": "adaf72e2a6d6f428ec465bc786ec41de868bbd53121997e89ba2299e9566c88213",
  "uid": "b84d1be5-caa5-4752-b078-8f40be39051d",
  "actions": ["search"],
  "indexes": ["YOUR_INDEX_NAME"],
  "expiresAt": "2025-01-01T00:00:00Z",
  "createdAt": "2024-01-27T06:50:33.668329328Z",
  "updatedAt": "2024-01-27T06:50:33.668329328Z"
}

该密钥可以根据需要在外部公开和使用，填入到你的插件选项中：

meilisearchPlugin({
  host: 'YOUR_HOST',
  apiKey: 'adaf72e2a6d6f428ec465bc786ec41de868bbd53121997e89ba2299e9566c88213',
  indexUid: 'YOUR_INDEX_NAME',
})