From a71b536a80e98aef172959ed1d8979288eefc93e Mon Sep 17 00:00:00 2001 From: "Calvin W." Date: Thu, 17 Jul 2025 15:22:30 +0800 Subject: [PATCH] Docs: revert search provider to agolia (#1564) * docs: revert search mode to agolia and fix formats * update repo link * update style reference page link --- README.md | 2 +- README_CN.md | 2 +- docs/.vitepress/config.mts | 9 +++++++-- docs/README.md | 11 ++++------- 4 files changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 732bf78d5..86203ca48 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ This section lists the main directories in the Olares repository: * **[`apps`](./apps)**: Contains the code for system applications, primarily for `larepass`. * **[`cli`](./cli)**: Contains the code for `olares-cli`, the command-line interface tool for Olares. * **[`daemon`](./daemon)**: Contains the code for `olaresd`, the system daemon process. -* **[`docs`**](./docs): Contains documentation for the project. +* **[`docs`](./docs)**: Contains documentation for the project. * **[`framework`](./framework)**: Contains the Olares system services. * **[`infrastructure`](./infrastructure)**: Contains code related to infrastructure components such as computing, storage, networking, and GPUs. * **[`platform`](./platform)**: Contains code for cloud-native components like databases and message queues. diff --git a/README_CN.md b/README_CN.md index 5c3e68bc9..05f36734c 100644 --- a/README_CN.md +++ b/README_CN.md @@ -115,7 +115,7 @@ Olares 代码库中的主要目录如下: * **[`apps`](./apps)**: 用于存放系统应用,主要是 `larepass` 的代码。 * **[`cli`](./cli)**: 用于存放 `olares-cli`(Olares 的命令行界面工具)的代码。 * **[`daemon`](./daemon)**: 用于存放 `olaresd`(系统守护进程)的代码。 -* **[`docs`**](./docs): 用于存放 Olares 项目的文档。 +* **[`docs`**](./docs)**: 用于存放 Olares 项目的文档。 * **[`framework`](./framework)**: 用来存放 Olares 系统服务代码。 * **[`infrastructure`](./infrastructure)**: 用于存放计算,存储,网络,GPU 等基础设施的代码。 * **[`platform`](./platform)**: 用于存放数据库、消息队列等云原生组件的代码。 diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 2af8fa0a6..5ae3d82e2 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -57,9 +57,14 @@ export default defineVersionedConfig2(withMermaid({ }, themeConfig: { search: { - provider: "local", + provider: "algolia", options: { - enhancedSearch: true, + appId: "DZ6H2FVQGO", + apiKey: "e5257d88b605dc0e5b82b12854aea9a5", + indexName: "olares", + searchParameters: { + queryLanguages: ["zh", "en"], + }, locales: { zh: { placeholder: "搜索文档", diff --git a/docs/README.md b/docs/README.md index 60baa294f..79f57b348 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,9 +6,9 @@ This directory includes the source files for the Olares documentation website, i ## Quick links -* **Published documentation site**: `https://docs.olares.com` -* **Olares official website**: `https://www.olares.com` -* **Olares project on GitHub**: `https://github.com/olares/olares` +* **Published documentation site**: https://docs.olares.com +* **Olares official website**: https://www.olares.com +* **Olares project on GitHub**: https://github.com/beclab/Olares ## Getting started with Olares documentation @@ -56,7 +56,4 @@ Creating a PR to a corresponding branch will automatically trigger the documenta ## Style guide -To ensure clarity, accuracy, and a consistent tone, please read our **[Content and Style Guide](https://github.com/beclab/docs/wiki/Markdown-reference)** before contributing. - -``` -``` \ No newline at end of file +To ensure clarity, accuracy, and a consistent tone, please read our **[Content and style guide](https://github.com/beclab/Olares/wiki/General-style-reference)** before contributing. \ No newline at end of file