改用 algolia 搜索

Jursin · Jursin · commit 58492db62ea0 · 2025-08-15T14:12:07.000+08:00
diff --git a/.github/workflows/docsearch.yml b/.github/workflows/docsearch.yml
@@ -0,0 +1,28 @@
+name: docsearch
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  algolia:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Get the content of docsearch.json as config
+        id: algolia_config
+        run: echo "::set-output name=config::$(cat docsearch.json | jq -r tostring)"
+
+      - name: Run algolia/docsearch-scraper image
+        env:
+          APPLICATION_ID: ${{ secrets.APPLICATION_ID }}
+          API_KEY: ${{ secrets.API_KEY }}
+          CONFIG: ${{ steps.algolia_config.outputs.config }}
+        run: |
+          docker run \
+            --env APPLICATION_ID=${APPLICATION_ID} \
+            --env API_KEY=${API_KEY} \
+            --env "CONFIG=${CONFIG}" \
+            algolia/docsearch-scraper
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
  # SecRandom 文档
 
-使用 VitePress 搭建
+使用 VitePress 搭建，Netlify 部署
+
+[![Netlify Status](https://api.netlify.com/api/v1/badges/f31b1cc4-0fdf-45fd-96f2-ef92ec108fde/deploy-status)](https://app.netlify.com/projects/secrandom/deploys)
 
 ## 快速开始
 - 环境要求
@@ -23,17 +25,16 @@
 - 预览生产版本
   ```bash
   npm run docs:preview
+  ```
 - 内容编写指南
   - 所有文档使用 Markdown 格式编写
   - 在 docs 目录下创建新的 .md 文件即可自动生成对应页面
   - 使用 Frontmatter 配置页面元数据：
   - 在 `/docs/.vitepress/config.mts` 中配置站点
 
 ## 贡献指南
-欢迎参与文档贡献：
-
 - Fork 本项目
-- 创建新分支
-- 提交更改
-- 推送到分支
+- 修改并提交 commit
+- 推送到 main 分支或新建 dev 分支
 - 创建 Pull Request
+- 等待审核后合并
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -78,21 +78,53 @@ export default defineConfig({
     ],
 
 
+    //Algolia搜索
     search: {
-      provider: "local",
+      provider: 'algolia',
       options: {
-        translations: {
-          button: {
-            buttonText: "搜索文档",
-            buttonAriaLabel: "搜索文档",
-          },
-          modal: {
-            noResultsText: "没有找到结果",
-            resetButtonTitle: "清除搜索条件",
-            footer: {
-              selectText: "选择",
-              navigateText: "切换",
-              closeText: "关闭",
+        appId: 'O2GGTAX57F',
+        apiKey: '59d5f4b8088ab3c4e3c436b0660b29d4',
+        indexName: 'doc',
+        locales: {
+          root: {
+            placeholder: '搜索文档',
+            translations: {
+              button: {
+                buttonText: '搜索文档',
+                buttonAriaLabel: '搜索文档'
+              },
+              modal: {
+                searchBox: {
+                  resetButtonTitle: '清除查询条件',
+                  resetButtonAriaLabel: '清除查询条件',
+                  cancelButtonText: '取消',
+                  cancelButtonAriaLabel: '取消'
+                },
+                startScreen: {
+                  recentSearchesTitle: '搜索历史',
+                  noRecentSearchesText: '没有搜索历史',
+                  saveRecentSearchButtonTitle: '保存至搜索历史',
+                  removeRecentSearchButtonTitle: '从搜索历史中移除',
+                  favoriteSearchesTitle: '收藏',
+                  removeFavoriteSearchButtonTitle: '从收藏中移除'
+                },
+                errorScreen: {
+                  titleText: '无法获取结果',
+                  helpText: '你可能需要检查你的网络连接'
+                },
+                footer: {
+                  selectText: '选择',
+                  navigateText: '切换',
+                  closeText: '关闭',
+                  searchByText: '搜索提供者'
+                },
+                noResultsScreen: {
+                  noResultsText: '无法找到相关结果',
+                  suggestedQueryText: '你可以尝试查询',
+                  reportMissingResultsText: '你认为该查询应该有结果？',
+                  reportMissingResultsLinkText: '点击反馈'
+                },
+              },
             },
           },
         },
diff --git a/docsearch.json b/docsearch.json
@@ -0,0 +1,35 @@
+{
+    "index_name": "doc",
+    "start_urls": [
+        {
+            "url": "https://secrandom.netlify.app",
+            "selectors_key": ""
+        }
+    ],
+    "stop_urls": [],
+    "selectors": {
+        "default": {
+            "lvl0": {
+                "selector": "",
+                "default_value": "我的文档"
+            },
+            "lvl1": ".content h1",
+            "lvl2": ".content h2",
+            "lvl3": ".content h3",
+            "lvl4": ".content h4",
+            "lvl5": ".content h5",
+            "lvl6": ".content h6",
+            "text": ".content p, .content li",
+            "lang": {
+                "selector": "/html/@lang",
+                "type": "xpath",
+                "global": true
+            }
+        }
+    },
+    "custom_settings": {
+        "attributesForFaceting": [
+            "lang"
+        ]
+    }
+}
