From 04d8e53e26016ba235114f219a8e5d5c387f6d98 Mon Sep 17 00:00:00 2001 From: CanisMinor Date: Sun, 17 Mar 2024 22:23:30 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20improve=20docs=20(#1597)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 📝 docs: Update docs to fit the new docs theme * 📝 docs: Update docs * 🔧 chore: fix build * Update tts.zh-CN.mdx * Update tts.mdx --------- Co-authored-by: arvinxx --- docs/self-hosting/advanced/analytics.mdx | 2 - .../self-hosting/advanced/analytics.zh-CN.mdx | 2 - docs/self-hosting/advanced/authentication.mdx | 8 +-- .../advanced/authentication.zh-CN.mdx | 8 +-- .../advanced/sso-providers/auth0.mdx | 22 +++--- .../advanced/sso-providers/auth0.zh-CN.mdx | 22 +++--- .../sso-providers/microsoft-entra-id.mdx | 15 ++-- .../microsoft-entra-id.zh-CN.mdx | 68 +++++++++---------- docs/self-hosting/advanced/upstream-sync.mdx | 8 ++- .../advanced/upstream-sync.zh-CN.mdx | 8 ++- docs/self-hosting/environment-variables.mdx | 2 - .../environment-variables.zh-CN.mdx | 7 +- .../environment-variables/basic.mdx | 2 - .../environment-variables/basic.zh-CN.mdx | 2 - docs/self-hosting/examples/azure-openai.mdx | 6 +- .../examples/azure-openai.zh-CN.mdx | 6 +- docs/self-hosting/platform/docker-compose.mdx | 10 ++- .../platform/docker-compose.zh-CN.mdx | 10 ++- docs/self-hosting/platform/docker.mdx | 14 ++-- docs/self-hosting/platform/docker.zh-CN.mdx | 14 ++-- docs/self-hosting/platform/netlify.mdx | 26 ++++--- docs/self-hosting/platform/netlify.zh-CN.mdx | 26 ++++--- docs/self-hosting/platform/repocloud.mdx | 2 - .../self-hosting/platform/repocloud.zh-CN.mdx | 2 - docs/self-hosting/platform/sealos.mdx | 2 - docs/self-hosting/platform/sealos.zh-CN.mdx | 2 - docs/self-hosting/platform/vercel.mdx | 2 - docs/self-hosting/platform/vercel.zh-CN.mdx | 2 - docs/self-hosting/platform/zeabur.mdx | 2 - docs/self-hosting/platform/zeabur.zh-CN.mdx | 2 - docs/usage/agents/concepts.mdx | 10 +-- docs/usage/agents/concepts.zh-CN.mdx | 4 +- docs/usage/agents/custom-agent.mdx | 21 +++--- docs/usage/agents/custom-agent.zh-CN.mdx | 18 +++-- docs/usage/agents/model.mdx | 6 +- docs/usage/agents/model.zh-CN.mdx | 6 +- docs/usage/agents/prompt.mdx | 6 +- docs/usage/agents/prompt.zh-CN.mdx | 6 +- docs/usage/agents/topics.mdx | 2 +- docs/usage/agents/topics.zh-CN.mdx | 2 +- docs/usage/features/agent-market.mdx | 22 ++---- docs/usage/features/agent-market.zh-CN.mdx | 21 +----- docs/usage/features/local-llm.mdx | 4 +- docs/usage/features/local-llm.zh-CN.mdx | 4 +- docs/usage/features/more.mdx | 2 - docs/usage/features/more.zh-CN.mdx | 2 - docs/usage/features/multi-ai-providers.mdx | 6 +- .../features/multi-ai-providers.zh-CN.mdx | 6 +- docs/usage/features/plugin-system.mdx | 16 +---- docs/usage/features/plugin-system.zh-CN.mdx | 16 +---- docs/usage/features/pwa.mdx | 4 +- docs/usage/features/pwa.zh-CN.mdx | 4 +- docs/usage/features/text-to-image.mdx | 1 + docs/usage/features/text-to-image.zh-CN.mdx | 1 + docs/usage/features/theme.mdx | 6 +- docs/usage/features/theme.zh-CN.mdx | 6 +- docs/usage/features/tts.mdx | 9 ++- docs/usage/features/tts.zh-CN.mdx | 11 +-- docs/usage/features/vision.mdx | 1 + docs/usage/features/vision.zh-CN.mdx | 1 + docs/usage/plugins/basic-usage.mdx | 12 ++-- docs/usage/plugins/basic-usage.zh-CN.mdx | 12 ++-- docs/usage/plugins/custom-plugin.mdx | 6 +- docs/usage/plugins/custom-plugin.zh-CN.mdx | 6 +- docs/usage/plugins/development.mdx | 64 ++++++++--------- docs/usage/plugins/development.zh-CN.mdx | 64 ++++++++--------- docs/usage/plugins/store.mdx | 6 +- docs/usage/plugins/store.zh-CN.mdx | 6 +- docs/usage/providers/ollama.mdx | 20 +++--- docs/usage/providers/ollama.zh-CN.mdx | 21 +++--- docs/usage/providers/ollama/gemma.mdx | 8 +-- docs/usage/providers/ollama/gemma.zh-CN.mdx | 6 +- docs/usage/start.mdx | 1 + docs/usage/start.zh-CN.mdx | 1 + package.json | 1 + 75 files changed, 352 insertions(+), 410 deletions(-) diff --git a/docs/self-hosting/advanced/analytics.mdx b/docs/self-hosting/advanced/analytics.mdx index 222e3526c402f..24cab7159c9cb 100644 --- a/docs/self-hosting/advanced/analytics.mdx +++ b/docs/self-hosting/advanced/analytics.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # Data Analysis To better help analyze the usage of LobeChat users, we have integrated several free/open-source data analytics services in LobeChat for collecting user usage data, which you can enable as needed. diff --git a/docs/self-hosting/advanced/analytics.zh-CN.mdx b/docs/self-hosting/advanced/analytics.zh-CN.mdx index dd441dba8b41f..0773a27c3db4e 100644 --- a/docs/self-hosting/advanced/analytics.zh-CN.mdx +++ b/docs/self-hosting/advanced/analytics.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # 数据分析 为更好地帮助分析 LobeChat 的用户使用情况，我们在 LobeChat 中集成了若干免费 / 开源的数据统计服务，用于收集用户的使用情况，你可以按需开启。 diff --git a/docs/self-hosting/advanced/authentication.mdx b/docs/self-hosting/advanced/authentication.mdx index 8985483e72b93..bddc3ef4fcade 100644 --- a/docs/self-hosting/advanced/authentication.mdx +++ b/docs/self-hosting/advanced/authentication.mdx @@ -15,10 +15,10 @@ To simultaneously enable multiple identity verification sources, please set the The order corresponds to the display order of the SSO providers. -| SSO Provider | Value | -| ------------------ | -------- | -| Auth0 | auth0 | -| Microsoft Entra ID | azure-ad | +| SSO Provider | Value | +| ------------------ | ---------- | +| Auth0 | `auth0` | +| Microsoft Entra ID | `azure-ad` | ## Other SSO Providers diff --git a/docs/self-hosting/advanced/authentication.zh-CN.mdx b/docs/self-hosting/advanced/authentication.zh-CN.mdx index 5567dea1ce750..9e59bb6a73874 100644 --- a/docs/self-hosting/advanced/authentication.zh-CN.mdx +++ b/docs/self-hosting/advanced/authentication.zh-CN.mdx @@ -15,10 +15,10 @@ LobeChat 支持配置外部身份验证服务，供企业 / 组织内部使用 顺序为 SSO 提供商的显示顺序。 -| SSO 提供商 | 值 | -| ------------------ | -------- | -| Auth0 | auth0 | -| Microsoft Entra ID | azure-ad | +| SSO 提供商 | 值 | +| ------------------ | ---------- | +| Auth0 | `auth0` | +| Microsoft Entra ID | `azure-ad` | ## 其他 SSO 提供商 diff --git a/docs/self-hosting/advanced/sso-providers/auth0.mdx b/docs/self-hosting/advanced/sso-providers/auth0.mdx index 9eaa29de9ce6e..5bcec9eff5962 100644 --- a/docs/self-hosting/advanced/sso-providers/auth0.mdx +++ b/docs/self-hosting/advanced/sso-providers/auth0.mdx @@ -1,5 +1,3 @@ -import { Callout, Steps } from 'nextra/components'; - # Configure Auth0 Identity Verification Service @@ -7,15 +5,15 @@ import { Callout, Steps } from 'nextra/components'; Register and log in to [Auth0][auth0-client-page], click on the "Applications" in the left navigation bar to switch to the application management interface, and click "Create Application" in the upper right corner to create an application. - ![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/1b405347-f4c3-4c55-82f6-47116f2210d0) + Create Auth0 Application S1 Fill in the application name you want to display to the organization users, choose any application type, and click "Create". - ![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/75c92f85-3ad3-4473-a9c6-e667e28d428d) + Create Auth0 Application S2 After successful creation, click on the corresponding application to enter the application details page, switch to the "Settings" tab, and you can see the corresponding configuration information. - ![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/a1ed996b-95ef-4b7d-a50d-b4666eccfecb) + Create Auth0 Application S3 In the application configuration page, you also need to configure Allowed Callback URLs, where you should fill in: @@ -23,9 +21,9 @@ import { Callout, Steps } from 'nextra/components'; http(s)://your-domain/api/auth/callback/auth0 ``` - ![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/575f46aa-f485-49bd-8b90-dbb1ce1a5c1b) + Create Auth0 Application S4 - + You can fill in or modify Allowed Callback URLs after deployment, but make sure the filled URL is consistent with the deployed URL. @@ -34,7 +32,7 @@ import { Callout, Steps } from 'nextra/components'; Click on the "Users Management" in the left navigation bar to enter the user management interface, where you can create users for your organization to log in to LobeChat. - ![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/3b8127ab-dc4f-4ff9-a4cb-dec3ef0295cc) + Add Users ### Configure Environment Variables @@ -51,7 +49,9 @@ import { Callout, Steps } from 'nextra/components'; | `ACCESS_CODE` | Required | Add a password to access this service. You can set a sufficiently long random password to "disable" access code authorization. | | `NEXTAUTH_URL` | Optional | The URL is used to specify the callback address for the execution of OAuth authentication in Auth.js. It needs to be set only when the default address is incorrect. `https://example.com/api/auth` | - You can refer to the related variable details at [📘Environment Variables](/en/self-hosting/environment-variable#auth0). + + You can refer to the related variable details at [📘Environment Variables](/en/self-hosting/environment-variable#auth0). + @@ -67,13 +67,13 @@ If your enterprise or organization already has a unified identity authentication Auth0 supports single sign-on services such as Azure Active Directory, Slack, Google Workspace, Office 365, Zoom, and more. For a detailed list of supported services, please refer to [this link][auth0-sso-integrations]. -![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/32650f4f-d0b0-4843-b26d-d35bad11d8a3) +Connecting to an Existing Single Sign-On Service ### Configuring Social Login If your enterprise or organization needs to support external user logins, you can configure social login services in Authentication -> Social. -![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/7b6f6a6c-2686-49d8-9dbd-0516053f1efa) +Configuring Social Login Configuring social login services by default allows anyone to authenticate, which may lead to diff --git a/docs/self-hosting/advanced/sso-providers/auth0.zh-CN.mdx b/docs/self-hosting/advanced/sso-providers/auth0.zh-CN.mdx index aa80a27a7e295..070e9b504f421 100644 --- a/docs/self-hosting/advanced/sso-providers/auth0.zh-CN.mdx +++ b/docs/self-hosting/advanced/sso-providers/auth0.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Callout, Steps } from 'nextra/components'; - # 配置 Auth0 身份验证服务 @@ -7,15 +5,15 @@ import { Callout, Steps } from 'nextra/components'; 注册并登录 [Auth0][auth0-client-page]，点击左侧导航栏的「Applications」，切换到应用管理界面，点击右上角「Create Application」以创建应用。 - ![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/1b405347-f4c3-4c55-82f6-47116f2210d0) + 创建 Auth0 应用 S1 填写你想向组织用户显示的应用名称，可选择任意应用类型，点击「Create」。 - ![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/75c92f85-3ad3-4473-a9c6-e667e28d428d) + 创建 Auth0 应用 S2 创建成功后，点击相应的应用，进入应用详情页，切换到「Settings」标签页，就可以看到相应的配置信息 - ![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/a1ed996b-95ef-4b7d-a50d-b4666eccfecb) + 创建 Auth0 应用 S3 在应用配置页面中，还需要配置 Allowed Callback URLs，在此处填写: @@ -23,9 +21,9 @@ import { Callout, Steps } from 'nextra/components'; http(s)://your-domain/api/auth/callback/auth0 ``` - ![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/575f46aa-f485-49bd-8b90-dbb1ce1a5c1b) + 创建 Auth0 应用 S4 - + 可以在部署后再填写或修改 Allowed Callback URLs，但是务必保证填写的 URL 与部署的 URL 一致 @@ -33,7 +31,7 @@ import { Callout, Steps } from 'nextra/components'; 点击左侧导航栏的「Users Management」，进入用户管理界面，可以为你的组织新建用户，用以登录 LobeChat - ![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/3b8127ab-dc4f-4ff9-a4cb-dec3ef0295cc) + 新增用户 ### 配置环境变量 @@ -50,7 +48,9 @@ import { Callout, Steps } from 'nextra/components'; | `ACCESS_CODE` | 必选 | 添加访问此服务的密码，你可以设置一个足够长的随机密码以 “禁用” 访问码授权 | | `NEXTAUTH_URL` | 可选 | 该 URL 用于指定 Auth.js 在执行 OAuth 验证时的回调地址，当默认生成的重定向地址发生不正确时才需要设置。`https://example.com/api/auth` | - 前往 [📘 环境变量](/zh/self-hosting/environment-variable#auth0) 可查阅相关变量详情。 + + 前往 [📘 环境变量](/zh/self-hosting/environment-variable#auth0) 可查阅相关变量详情。 + 部署成功后，用户将可以使用 Auth0 中配置的用户通过身份认证并使用 LobeChat。 @@ -63,13 +63,13 @@ import { Callout, Steps } from 'nextra/components'; Auth0 支持 Azure Active Directory / Slack / Google Workspace / Office 365 / Zoom 等单点登录服务，详细支持列表可参考 [这里][auth0-sso-integrations] -![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/32650f4f-d0b0-4843-b26d-d35bad11d8a3) +Connecting to an Existing Single Sign-On Service ### 配置社交登录 如果你的企业或组织需要支持外部人员登录，可以在 Authentication -> Social 中，配置社交登录服务。 -![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/7b6f6a6c-2686-49d8-9dbd-0516053f1efa) +Configuring Social Login 配置社交登录服务默认会允许所有人通过认证，这可能会导致 LobeChat 被外部人员滥用。 diff --git a/docs/self-hosting/advanced/sso-providers/microsoft-entra-id.mdx b/docs/self-hosting/advanced/sso-providers/microsoft-entra-id.mdx index 9fae2d9822eef..df1dead197caf 100644 --- a/docs/self-hosting/advanced/sso-providers/microsoft-entra-id.mdx +++ b/docs/self-hosting/advanced/sso-providers/microsoft-entra-id.mdx @@ -10,7 +10,7 @@ In the `Redirect URI (optional)` section, for the application type, select `Web`, and in the Callback URL, enter: ```bash - https:///api/auth/callback/azure-ad + https://your-domain/api/auth/callback/azure-ad ``` @@ -18,19 +18,19 @@ - Please replace "your-domain" with your own domain. - ![App Register](https://github.com/lobehub/lobe-chat/assets/13883964/4f9d83bd-b3fc-4abc-bcf4-ccbad65c219d) + App Register Click on "Register". After successfully creating the application, click on the corresponding application to enter the application details page, and switch to the "Overview" tab to view the corresponding configuration information. - ![App Overview](https://github.com/lobehub/lobe-chat/assets/13883964/48a0b702-05bd-4ce4-a007-a8ad00a36e5a) + App Overview Go to "Certificates & secrets", select the "Client secrets" tab, click on "New client secret", fill in the description, select the expiration time, and click on "Add" to create a new client secret. - ![Create App Client Secret](https://github.com/lobehub/lobe-chat/assets/13883964/c9d66fa0-158c-4bd3-a1fa-969e638259d2) + Create App Client Secret - Please make sure to save your client secret as this is your only chance to view it. + Please make sure to save your client secret as this is your only chance to view it. ### Add Users @@ -51,7 +51,10 @@ | `ACCESS_CODE` | Required | Add a password for accessing this service, you can set a sufficiently long random password to "disable" access code authorization. | | `NEXTAUTH_URL` | Optional | This URL is used to specify the callback address for Auth.js when performing OAuth authentication. It is only necessary to set it when the default generated redirect address is incorrect. `https://example.com/api/auth` | - You can refer to [📘 environment variables](/en/self-hosting/environment-variable#microsoft-entra-id) for details on related variables. + + You can refer to [📘 environment variables](/en/self-hosting/environment-variable#microsoft-entra-id) for details on related variables. + + After successful deployment, users will be able to authenticate and use LobeChat using the users configured in Microsoft Entra ID. diff --git a/docs/self-hosting/advanced/sso-providers/microsoft-entra-id.zh-CN.mdx b/docs/self-hosting/advanced/sso-providers/microsoft-entra-id.zh-CN.mdx index 2d2e04044c530..dd349b6c257d6 100644 --- a/docs/self-hosting/advanced/sso-providers/microsoft-entra-id.zh-CN.mdx +++ b/docs/self-hosting/advanced/sso-providers/microsoft-entra-id.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Callout, Steps } from 'nextra/components'; - # 配置 Microsoft Entra ID 身份验证服务 ## Microsoft Entra ID 配置流程 @@ -7,55 +5,57 @@ import { Callout, Steps } from 'nextra/components'; ### 创建 Microsoft Entra ID 应用 -在你的 [Microsoft Azure Portal][microsoft-azure-portal] 进入 Microsoft Entra ID -> App registrations -> New registration 创建一个新的应用。 + 在你的 [Microsoft Azure Portal][microsoft-azure-portal] 进入 Microsoft Entra ID -> App registrations -> New registration 创建一个新的应用。 -填写你想向组织用户显示的应用名称，选择你期望支持的账户类型，如果只支持内部用户请选择 `Accounts in this organizational directory only (Default Directory only - Single tenant)`。 + 填写你想向组织用户显示的应用名称，选择你期望支持的账户类型，如果只支持内部用户请选择 `Accounts in this organizational directory only (Default Directory only - Single tenant)`。 -在 `Redirect URI (optional)` 中，应用类型选择 `Web`，Callback URL, 处填写： + 在 `Redirect URI (optional)` 中，应用类型选择 `Web`，Callback URL, 处填写： -```bash -https://your-domain/api/auth/callback/azure-ad -``` + ```bash + https://your-domain/api/auth/callback/azure-ad + ``` - - - 可以在 Register 后再填写或修改 Redirect URIs，但是务必保证填写的 URL 与部署的 URL 一致。 - - your-domain 请填写自己的域名 - + + - 可以在 Register 后再填写或修改 Redirect URIs，但是务必保证填写的 URL 与部署的 URL 一致。 + - your-domain 请填写自己的域名 + -![App Register](https://github.com/lobehub/lobe-chat/assets/13883964/4f9d83bd-b3fc-4abc-bcf4-ccbad65c219d) + App Register -点击「Register」 + 点击「Register」 -创建成功后，点击相应的应用，进入应用详情页，切换到「Overview」标签页，就可以看到相应的配置信息。 + 创建成功后，点击相应的应用，进入应用详情页，切换到「Overview」标签页，就可以看到相应的配置信息。 -![App Overview](https://github.com/lobehub/lobe-chat/assets/13883964/48a0b702-05bd-4ce4-a007-a8ad00a36e5a) + App Overview -进入「Certificates & secrets」，选择「Client secrets」标签，点击「New client secret」，填写描述，选择过期时间，点击「Add」，创建一个新的客户端密钥。 + 进入「Certificates & secrets」，选择「Client secrets」标签，点击「New client secret」，填写描述，选择过期时间，点击「Add」，创建一个新的客户端密钥。 -![Create App Client Secret](https://github.com/lobehub/lobe-chat/assets/13883964/c9d66fa0-158c-4bd3-a1fa-969e638259d2) + Create App Client Secret -=请务必保存好你的客户端密钥，因为这是你唯一的机会查看它。 + 请务必保存好你的客户端密钥，因为这是你唯一的机会查看它。 -### 新增用户 + ### 新增用户 -回到「Microsoft Entra ID」界面，进入「Users」，点击「New user」，填写用户信息，点击「Create」，创建用户以使用 LobeChat。 + 回到「Microsoft Entra ID」界面，进入「Users」，点击「New user」，填写用户信息，点击「Create」，创建用户以使用 LobeChat。 -### 配置环境变量 + ### 配置环境变量 -在部署 LobeChat 时，你需要配置以下环境变量： + 在部署 LobeChat 时，你需要配置以下环境变量： -| 环境变量 | 类型 | 描述 | -| --- | --- | --- | -| `ENABLE_OAUTH_SSO` | 必选 | 为 LobeChat 启用单点登录 (SSO)。设置为 `1` 以启用单点登录。 | -| `NEXTAUTH_SECRET` | 必选 | 用于加密 Auth.js 会话令牌的密钥。您可以使用以下命令生成秘钥： `openssl rand -base64 32` | -| `SSO_PROVIDERS` | 必选 | 选择 LoboChat 的单点登录提供商。使用 Microsoft Entra ID 请填写 `azure-ad`。 | -| `AZURE_AD_CLIENT_ID` | 必选 | Microsoft Entra ID 应用程序的 Client ID | -| `AZURE_AD_CLIENT_SECRET` | 必选 | Microsoft Entra ID 应用程序的 Client Secret | -| `AZURE_AD_TENANT_ID` | 必选 | Microsoft Entra ID 应用程序的 Tenant ID | -| `ACCESS_CODE` | 必选 | 添加访问此服务的密码，你可以设置一个足够长的随机密码以 “禁用” 访问码授权 | -| `NEXTAUTH_URL` | 可选 | 该 URL 用于指定 Auth.js 在执行 OAuth 验证时的回调地址，当默认生成的重定向地址发生不正确时才需要设置。`https://example.com/api/auth` | + | 环境变量 | 类型 | 描述 | + | ------------------------ | -- | ------------------------------------------------------------------------------------------- | + | `ENABLE_OAUTH_SSO` | 必选 | 为 LobeChat 启用单点登录 (SSO)。设置为 `1` 以启用单点登录。 | + | `NEXTAUTH_SECRET` | 必选 | 用于加密 Auth.js 会话令牌的密钥。您可以使用以下命令生成秘钥： `openssl rand -base64 32` | + | `SSO_PROVIDERS` | 必选 | 选择 LoboChat 的单点登录提供商。使用 Microsoft Entra ID 请填写 `azure-ad`。 | + | `AZURE_AD_CLIENT_ID` | 必选 | Microsoft Entra ID 应用程序的 Client ID | + | `AZURE_AD_CLIENT_SECRET` | 必选 | Microsoft Entra ID 应用程序的 Client Secret | + | `AZURE_AD_TENANT_ID` | 必选 | Microsoft Entra ID 应用程序的 Tenant ID | + | `ACCESS_CODE` | 必选 | 添加访问此服务的密码，你可以设置一个足够长的随机密码以 “禁用” 访问码授权 | + | `NEXTAUTH_URL` | 可选 | 该 URL 用于指定 Auth.js 在执行 OAuth 验证时的回调地址，当默认生成的重定向地址发生不正确时才需要设置。`https://example.com/api/auth` | - 前往 [📘 环境变量](/zh/self-hosting/environment-variable#microsoft-entra-id) 可查阅相关变量详情。 + + 前往 [📘 环境变量](/zh/self-hosting/environment-variable#microsoft-entra-id) 可查阅相关变量详情。 + diff --git a/docs/self-hosting/advanced/upstream-sync.mdx b/docs/self-hosting/advanced/upstream-sync.mdx index def579998e2cf..d225387d5d714 100644 --- a/docs/self-hosting/advanced/upstream-sync.mdx +++ b/docs/self-hosting/advanced/upstream-sync.mdx @@ -1,4 +1,4 @@ -import { Callout, Steps } from 'nextra/components'; +# Upstream Sync ## `A` Vercel / Zeabur Deployment @@ -16,7 +16,9 @@ If you deployed your project according to the one-click deployment steps in the After forking the project, due to Github's limitations, you need to manually enable Workflows on the Actions page of your forked project and start the Upstream Sync Action. Once enabled, you can set up automatic updates to occur every hour. -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985117-4d48fe7b-0412-4667-8129-b25ebcf2c9de.png) ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png) +Enable Automatic Updates S1 + +Enable Automatic Updates S2 ## `B` Docker Deployment @@ -56,7 +58,7 @@ Upgrading the Docker deployment version is very simple, you just need to redeplo Ensure that you have sufficient permissions to stop and remove the container before executing these commands, and that Docker has sufficient permissions to pull the new image. - + **If I redeploy, will I lose my local chat records?** No need to worry, you won't. All of LobeChat's chat records are stored in your local browser. Therefore, when redeploying LobeChat using Docker, your chat records will not be lost. diff --git a/docs/self-hosting/advanced/upstream-sync.zh-CN.mdx b/docs/self-hosting/advanced/upstream-sync.zh-CN.mdx index e2bbf6c2261a1..b7e0376e29489 100644 --- a/docs/self-hosting/advanced/upstream-sync.zh-CN.mdx +++ b/docs/self-hosting/advanced/upstream-sync.zh-CN.mdx @@ -1,4 +1,4 @@ -import { Callout, Steps } from 'nextra/components'; +# 启动自动更新 ## `A` Vercel / Zeabur 部署 @@ -14,7 +14,9 @@ import { Callout, Steps } from 'nextra/components'; 当你 Fork 了项目后，由于 Github 的限制，你需要手动在你 Fork 的项目的 Actions 页面启用 Workflows，并启动 Upstream Sync Action。启用后，你可以设置每小时进行一次自动更新。 -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985117-4d48fe7b-0412-4667-8129-b25ebcf2c9de.png) ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png) +启动自动更新 S1 + +启动自动更新 S2 ## `B` Docker 部署 @@ -54,7 +56,7 @@ Docker 部署版本的升级非常简单，只需要重新部署 LobeChat 的最 确保在执行这些命令之前，您有足够的权限来停止和删除容器，并且 Docker 有足够的权限来拉取新的镜像。 - + **重新部署的话，我本地的聊天记录会丢失吗？** 放心，不会的。LobeChat 的聊天记录全部都存储在你的本地浏览器中。因此使用 Docker 重新部署 LobeChat 时，你的聊天记录并不会丢失。 diff --git a/docs/self-hosting/environment-variables.mdx b/docs/self-hosting/environment-variables.mdx index 1502afd500b0c..59ede77763865 100644 --- a/docs/self-hosting/environment-variables.mdx +++ b/docs/self-hosting/environment-variables.mdx @@ -1,5 +1,3 @@ -import { Cards } from 'nextra/components'; - # Environment Variables LobeChat provides some additional configuration options when deployed, which can be customized using environment variables. diff --git a/docs/self-hosting/environment-variables.zh-CN.mdx b/docs/self-hosting/environment-variables.zh-CN.mdx index a2b6923b7f422..b021d805c64f7 100644 --- a/docs/self-hosting/environment-variables.zh-CN.mdx +++ b/docs/self-hosting/environment-variables.zh-CN.mdx @@ -1,10 +1,9 @@ -import { Cards } from 'nextra/components'; - # 环境变量 LobeChat 在部署时提供了一些额外的配置项，你可以使用环境变量进行自定义设置。 - - + + + diff --git a/docs/self-hosting/environment-variables/basic.mdx b/docs/self-hosting/environment-variables/basic.mdx index 425b07fdc4302..1cb44cc1ea9ae 100644 --- a/docs/self-hosting/environment-variables/basic.mdx +++ b/docs/self-hosting/environment-variables/basic.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # Environment Variables LobeChat provides some additional configuration options during deployment, which can be customized using environment variables. diff --git a/docs/self-hosting/environment-variables/basic.zh-CN.mdx b/docs/self-hosting/environment-variables/basic.zh-CN.mdx index ec77f57b613be..f65dd2a023229 100644 --- a/docs/self-hosting/environment-variables/basic.zh-CN.mdx +++ b/docs/self-hosting/environment-variables/basic.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # 环境变量 LobeChat 在部署时提供了一些额外的配置项，你可以使用环境变量进行自定义设置。 diff --git a/docs/self-hosting/examples/azure-openai.mdx b/docs/self-hosting/examples/azure-openai.mdx index 5ebfdc407156f..027831c10a244 100644 --- a/docs/self-hosting/examples/azure-openai.mdx +++ b/docs/self-hosting/examples/azure-openai.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # Integrating with Azure OpenAI LobeChat supports using [Azure OpenAI][azure-openai-url] as the model service provider for OpenAI. This article will explain how to configure Azure OpenAI. @@ -9,14 +7,14 @@ LobeChat supports using [Azure OpenAI][azure-openai-url] as the model service pr Due to development costs ([#178][rfc]), the current version of LobeChat does not fully comply with the implementation model of Azure OpenAI. Instead, it adopts a solution based on `openai` to be compatible with Azure OpenAI. As a result, the following limitations exist: - Only one of OpenAI and Azure OpenAI can be selected. Once you enable Azure OpenAI, you will not be able to use OpenAI as the model service provider. -- LobeChat requires the deployment name to be the same as the model name in order to function properly. For example, the deployment name for the `gpt-35-turbo` model must be `gpt-35-turbo`. Otherwise, LobeChat will not be able to match the corresponding model correctly. ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/267082091-d89d53d3-1c8c-40ca-ba15-0a9af2a79264.png) +- LobeChat requires the deployment name to be the same as the model name in order to function properly. For example, the deployment name for the `gpt-35-turbo` model must be `gpt-35-turbo`. Otherwise, LobeChat will not be able to match the corresponding model correctly. Usage Limitations - Due to the complexity of integrating with Azure OpenAI's SDK, it is currently not possible to query the list of configured models. ## Configuring in the Interface Click in the bottom left corner "Actions" - "Settings", then switch to the "Language Model" tab and enable the "Azure OpenAI" switch to start using Azure OpenAI. -![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/267083420-422a3714-627e-4bef-9fbc-141a2a8ca916.png) +Configuring in the Interface You can fill in the corresponding configuration items as needed: diff --git a/docs/self-hosting/examples/azure-openai.zh-CN.mdx b/docs/self-hosting/examples/azure-openai.zh-CN.mdx index 7ecbee9ab4774..bcd953a3011b4 100644 --- a/docs/self-hosting/examples/azure-openai.zh-CN.mdx +++ b/docs/self-hosting/examples/azure-openai.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # 与 Azure OpenAI 集成使用 LobeChat 支持使用 [Azure OpenAI][azure-openai-url] 作为 OpenAI 的模型服务商，本文将介绍如何配置 Azure OpenAI。 @@ -9,14 +7,14 @@ LobeChat 支持使用 [Azure OpenAI][azure-openai-url] 作为 OpenAI 的模型 从研发成本考虑 ([#178][rfc])，目前阶段的 LobeChat 并没有 100% 完全符合 Azure OpenAI 的实现模型，采用了以 `openai` 为基座，兼容 Azure OpeAI 的解决方案。因此会带来以下局限性： - OpenAI 与 Azure OpenAI 只能二选一，当你开启使用 Azure OpenAI 后，将无法使用 OpenAI 作为模型服务商； -- LobeChat 约定了与模型同名的部署名才能正常使用，比如 `gpt-35-turbo` 模型的部署名，必须为 `gpt-35-turbo`，否则 LobeChat 将无法正常正确匹配到相应模型 ![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/267082091-d89d53d3-1c8c-40ca-ba15-0a9af2a79264.png) +- LobeChat 约定了与模型同名的部署名才能正常使用，比如 `gpt-35-turbo` 模型的部署名，必须为 `gpt-35-turbo`，否则 LobeChat 将无法正常正确匹配到相应模型 使用限制 - 由于 Azure OpenAI 的 SDK 接入复杂度，当前无法查询配置资源的模型列表； ## 在界面中配置 点击左下角「操作」 -「设置」，切到 「语言模型」 Tab 后通过开启「Azure OpenAI」开关，即可开启使用 Azure OpenAI。 -![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/267083420-422a3714-627e-4bef-9fbc-141a2a8ca916.png) +在界面中配置 你按需填写相应的配置项： diff --git a/docs/self-hosting/platform/docker-compose.mdx b/docs/self-hosting/platform/docker-compose.mdx index bbcf5b8585dfa..04c31c1b58e54 100644 --- a/docs/self-hosting/platform/docker-compose.mdx +++ b/docs/self-hosting/platform/docker-compose.mdx @@ -1,8 +1,12 @@ -import { Steps, Tabs } from 'nextra/components'; - # Docker Compose Deployment Guide -[![][docker-release-shield]][docker-release-link][![][docker-size-shield]][docker-size-link][![][docker-pulls-shield]][docker-pulls-link] +
+ [![][docker-release-shield]][docker-release-link] + + [![][docker-size-shield]][docker-size-link] + + [![][docker-pulls-shield]][docker-pulls-link] +
We provide a [Docker image][docker-release-link] for deploying the LobeChat service on your private device. diff --git a/docs/self-hosting/platform/docker-compose.zh-CN.mdx b/docs/self-hosting/platform/docker-compose.zh-CN.mdx index 9986288b30c68..e6e4becc49c0a 100644 --- a/docs/self-hosting/platform/docker-compose.zh-CN.mdx +++ b/docs/self-hosting/platform/docker-compose.zh-CN.mdx @@ -1,8 +1,12 @@ -import { Steps, Tabs } from 'nextra/components'; - # Docker Compose 部署指引 -[![][docker-release-shield]][docker-release-link][![][docker-size-shield]][docker-size-link][![][docker-pulls-shield]][docker-pulls-link] +
+ [![][docker-release-shield]][docker-release-link] + + [![][docker-size-shield]][docker-size-link] + + [![][docker-pulls-shield]][docker-pulls-link] +
我们提供了 [Docker 镜像][docker-release-link]，供你在自己的私有设备上部署 LobeChat 服务。 diff --git a/docs/self-hosting/platform/docker.mdx b/docs/self-hosting/platform/docker.mdx index f5bcb2320d380..78d781347e87a 100644 --- a/docs/self-hosting/platform/docker.mdx +++ b/docs/self-hosting/platform/docker.mdx @@ -1,8 +1,12 @@ -import { Callout, Steps, Tabs } from 'nextra/components'; - # Docker Deployment Guide -[![][docker-release-shield]][docker-release-link][![][docker-size-shield]][docker-size-link][![][docker-pulls-shield]][docker-pulls-link] +
+ [![][docker-release-shield]][docker-release-link] + + [![][docker-size-shield]][docker-size-link] + + [![][docker-pulls-shield]][docker-pulls-link] +
We provide a [Docker image][docker-release-link] for you to deploy the LobeChat service on your private device. @@ -45,7 +49,7 @@ We provide a [Docker image][docker-release-link] for you to deploy the LobeChat - For the complete list of environment variables supported by LobeChat, please refer to the [Environment Variables](/zh/self-hosting/environment-ariable) section. - + Since the official Docker image build takes about half an hour, if you see the "update available" prompt after deployment, you can wait for the image to finish building before deploying again. @@ -56,7 +60,7 @@ We provide a [Docker image][docker-release-link] for you to deploy the LobeChat stolen!!!](https://github.com/lobehub/lobe-chat/issues/1123). - + Note that when the **deployment architecture is inconsistent with the image**, you need to cross-compile **Sharp**, see [Sharp Cross-Compilation](https://sharp.pixelplumbing.com/install#cross-platform) for details. diff --git a/docs/self-hosting/platform/docker.zh-CN.mdx b/docs/self-hosting/platform/docker.zh-CN.mdx index bd789646bf043..e62339a6a5be7 100644 --- a/docs/self-hosting/platform/docker.zh-CN.mdx +++ b/docs/self-hosting/platform/docker.zh-CN.mdx @@ -1,8 +1,12 @@ -import { Callout, Steps, Tabs } from 'nextra/components'; - # Docker 部署指引 -[![][docker-release-shield]][docker-release-link][![][docker-size-shield]][docker-size-link][![][docker-pulls-shield]][docker-pulls-link] +
+ [![][docker-release-shield]][docker-release-link] + + [![][docker-size-shield]][docker-size-link] + + [![][docker-pulls-shield]][docker-pulls-link] +
我们提供了 [Docker 镜像][docker-release-link]，供你在自己的私有设备上部署 LobeChat 服务。 @@ -42,7 +46,7 @@ import { Callout, Steps, Tabs } from 'nextra/components'; - 默认映射端口为 `3210`, 请确保未被占用或手动更改端口映射 - 使用你的 OpenAI API Key 替换上述命令中的 `sk-xxxx` - + LobeChat 支持的完整环境变量列表请参考 [📘 环境变量](/zh/self-hosting/environment-variables) 部分 @@ -56,7 +60,7 @@ import { Callout, Steps, Tabs } from 'nextra/components'; stolen!!!](https://github.com/lobehub/lobe-chat/issues/1123) 这样的情况 - + 注意，当**部署架构与镜像的不一致时**，需要对 **Sharp** 进行交叉编译，详见 [Sharp 交叉编译](https://sharp.pixelplumbing.com/install#cross-platform) diff --git a/docs/self-hosting/platform/netlify.mdx b/docs/self-hosting/platform/netlify.mdx index 38f4421d67612..53d7d7ea2a9a3 100644 --- a/docs/self-hosting/platform/netlify.mdx +++ b/docs/self-hosting/platform/netlify.mdx @@ -1,5 +1,3 @@ -import { Callout, Steps } from 'nextra/components'; - # Deploy LobeChat with Netlify If you want to deploy LobeChat on Netlify, you can follow these steps: @@ -24,25 +22,25 @@ If you want to deploy LobeChat on Netlify, you can follow these steps: Click "Import from git" - {'Click + {'Click Then click "Deploy with Github" and authorize Netlify to access your GitHub account. - {'Authorize + {'Authorize Next, select the LobeChat project: - {'Select + {'Select ### Configure Site Name and Environment Variables In this step, you need to configure your site, including the site name, build command, and publish directory. Fill in your site name in the "Site Name" field. If there are no special requirements, you do not need to modify the remaining configurations as we have already set the default configurations. - {'Configure + {'Configure Click the "Add environment variables" button to add site environment variables: - {'Add + {'Add Taking OpenAI as an example, the environment variables you need to add are as follows: @@ -52,38 +50,38 @@ If you want to deploy LobeChat on Netlify, you can follow these steps: | `ACCESS_CODE` | Required | Add a password to access this service. You can set a long password to prevent brute force attacks. When this value is separated by commas, it becomes an array of passwords | `awCT74` or `e3@09!` or `code1,code2,code3` | | `OPENAI_PROXY_URL` | Optional | If you manually configure the OpenAI interface proxy, you can use this configuration to override the default OpenAI API request base URL | `https://aihubmix.com/v1`, default value: `https://api.openai.com/v1` | - + For a complete list of environment variables supported by LobeChat, please refer to the [📘 Environment Variables](/en/self-hosting/environment-variables) Afteradding the variables, finally click "Deploy lobe-chat" to enter the deployment phase - {'Environment + {'Environment ### Wait for Deployment to Complete After clicking deploy, you will enter the site details page, where you can click the "Deploying your site" in blue or the "Building" in yellow to view the deployment progress. - {'Netlify + {'Netlify Upon entering the deployment details, you will see the following interface, indicating that your LobeChat is currently being deployed. Simply wait for the deployment to complete. - {'LobeChat + {'LobeChat During the deployment and build process: - {'Deployment + {'Deployment ### Deployment Successful, Start Using If your Deploy Log in the interface looks like the following, it means your LobeChat has been successfully deployed. - {'Deployment + {'Deployment At this point, you can click on "Open production deploy" to access your LobeChat site. - {'Access + {'Access ## Set up Custom Domain (Optional) diff --git a/docs/self-hosting/platform/netlify.zh-CN.mdx b/docs/self-hosting/platform/netlify.zh-CN.mdx index 48ad066e9b27b..3fcff9881fd31 100644 --- a/docs/self-hosting/platform/netlify.zh-CN.mdx +++ b/docs/self-hosting/platform/netlify.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Callout, Steps } from 'nextra/components'; - # 使用 Netlify 部署 如果想在 Netlify 上部署 LobeChat，可以按照以下步骤进行操作： @@ -21,25 +19,25 @@ import { Callout, Steps } from 'nextra/components'; 点击 「Import from git」 - {'在 + {'在 然后点击 「Deploy with Github」，并授权 Netlify 访问你的 GitHub 账号 - {'授权 + {'授权 然后选择 LobeChat 项目： - {'选择 + {'选择 ### 配置站点名称与环境变量 在这一步，你需要配置你的站点，包括站点名称、构建命令、发布目录等。在「Site Name」字段填写上你的站点名称。其余配置如果没有特殊要求，无需修改，我们已经设定好了默认配置。 - {'配置 + {'配置 点击 「Add environment variables」按钮，添加站点环境变量： - {'添加 + {'添加 以配置 OpenAI 为例，你需要添加的环境变量如下： @@ -49,37 +47,37 @@ import { Callout, Steps } from 'nextra/components'; | `ACCESS_CODE` | 必选 | 添加访问此服务的密码，你可以设置一个长密码以防被爆破，该值用逗号分隔时为密码数组 | `awCT74` 或 `e3@09!` or `code1,code2,code3` | | `OPENAI_PROXY_URL` | 可选 | 如果你手动配置了 OpenAI 接口代理，可以使用此配置项来覆盖默认的 OpenAI API 请求基础 URL | `https://aihubmix.com/v1` ，默认值：`https://api.openai.com/v1` | - + LobeChat 支持的完整环境变量列表请参考 [📘 环境变量](/zh/self-hosting/environment-variables) 部分 添加完成后，最后点击「Deploy lobe-chat」 进入部署阶段。 - {'环境变量添加完成'} + {'环境变量添加完成'} ### 等待部署完成 点击部署后，会进入站点详情页面，你可以点击青色字样的「Deploying your site」或者 「Building」 黄色标签查看部署进度。 - {'Netlify + {'Netlify 进入部署详情，你会看到下述界面，这意味着你的 LobeChat 正在部署中，只需等待部署完成即可。 - {'LobeChat + {'LobeChat 部署构建过程中： - {'部署构建中'} + {'部署构建中'} ### 部署成功，开始使用 如果你的界面中的 Deploy Log 如下所示，意味着你的 LobeChat 部署成功了。 - {'部署成功'} + {'部署成功'} 此时，你可以点击「Open production deploy」，即可访问你的 LobeChat 站点 - {'访问你的 + {'访问你的 ## 绑定自定义域名（可选） diff --git a/docs/self-hosting/platform/repocloud.mdx b/docs/self-hosting/platform/repocloud.mdx index 4c30b4509b8f4..d04a90c1666cc 100644 --- a/docs/self-hosting/platform/repocloud.mdx +++ b/docs/self-hosting/platform/repocloud.mdx @@ -1,5 +1,3 @@ -import { Steps } from 'nextra/components'; - # Deploy LobeChat with RepoCloud If you want to deploy LobeChat on RepoCloud, you can follow the steps below: diff --git a/docs/self-hosting/platform/repocloud.zh-CN.mdx b/docs/self-hosting/platform/repocloud.zh-CN.mdx index 75220aa3c2f14..4390307c3ecdd 100644 --- a/docs/self-hosting/platform/repocloud.zh-CN.mdx +++ b/docs/self-hosting/platform/repocloud.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Steps } from 'nextra/components'; - # 使用 RepoCloud 部署 如果想在 RepoCloud 上部署 LobeChat，可以按照以下步骤进行操作： diff --git a/docs/self-hosting/platform/sealos.mdx b/docs/self-hosting/platform/sealos.mdx index 32e5eaafc1dbd..5a739b3fddd1d 100644 --- a/docs/self-hosting/platform/sealos.mdx +++ b/docs/self-hosting/platform/sealos.mdx @@ -1,5 +1,3 @@ -import { Steps } from 'nextra/components'; - # Deploy LobeChat with SealOS If you want to deploy LobeChat on SealOS, you can follow the steps below: diff --git a/docs/self-hosting/platform/sealos.zh-CN.mdx b/docs/self-hosting/platform/sealos.zh-CN.mdx index fdcf88c40dc71..81f4b4383f3b8 100644 --- a/docs/self-hosting/platform/sealos.zh-CN.mdx +++ b/docs/self-hosting/platform/sealos.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Steps } from 'nextra/components'; - # 使用 SealOS 部署 如果想在 SealOS 上部署 LobeChat，可以按照以下步骤进行操作： diff --git a/docs/self-hosting/platform/vercel.mdx b/docs/self-hosting/platform/vercel.mdx index afd9600e3608e..9e68ff8221c83 100644 --- a/docs/self-hosting/platform/vercel.mdx +++ b/docs/self-hosting/platform/vercel.mdx @@ -1,5 +1,3 @@ -import { Callout, Steps } from 'nextra/components'; - # Deploy LobeChat with Vercel If you want to deploy LobeChat on Vercel, you can follow the steps below: diff --git a/docs/self-hosting/platform/vercel.zh-CN.mdx b/docs/self-hosting/platform/vercel.zh-CN.mdx index 5a0a350a66782..799319160184c 100644 --- a/docs/self-hosting/platform/vercel.zh-CN.mdx +++ b/docs/self-hosting/platform/vercel.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Callout, Steps } from 'nextra/components'; - # Vercel 部署指引 如果想在 Vercel 上部署 LobeChat，可以按照以下步骤进行操作： diff --git a/docs/self-hosting/platform/zeabur.mdx b/docs/self-hosting/platform/zeabur.mdx index bf72e78c27f54..119b5020ab6a2 100644 --- a/docs/self-hosting/platform/zeabur.mdx +++ b/docs/self-hosting/platform/zeabur.mdx @@ -1,5 +1,3 @@ -import { Steps } from 'nextra/components'; - # Deploy LobeChat with Zeabur If you want to deploy LobeChat on Zeabur, you can follow the steps below: diff --git a/docs/self-hosting/platform/zeabur.zh-CN.mdx b/docs/self-hosting/platform/zeabur.zh-CN.mdx index d05627d672436..649e0f1e25cb5 100644 --- a/docs/self-hosting/platform/zeabur.zh-CN.mdx +++ b/docs/self-hosting/platform/zeabur.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Steps } from 'nextra/components'; - # 使用 Zeabur 部署 如果想在 Zeabur 上部署 LobeChat，可以按照以下步骤进行操作： diff --git a/docs/usage/agents/concepts.mdx b/docs/usage/agents/concepts.mdx index 0a17491962998..8661d4af911f9 100644 --- a/docs/usage/agents/concepts.mdx +++ b/docs/usage/agents/concepts.mdx @@ -4,14 +4,14 @@ In the official ChatGPT application, there is only the concept of "topics." As shown in the image, the user's historical conversation topics are listed in the sidebar. -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279602474-fe7cb3f3-8eb7-40d3-a69f-6615393bbd4e.png) +{'ChatGPT However, in our usage, we have found that this model has many issues. For example, the information indexing of historical conversations is too scattered. Additionally, when dealing with repetitive tasks, it is difficult to have a stable entry point. For instance, if I want ChatGPT to help me translate a document, in this model, I would need to constantly create new topics and then set up the translation prompt I had previously created. When there are high-frequency tasks, this will result in a very inefficient interaction format. -## "Topics" and "Assistants" +## Topics and "Agent" -Therefore, in LobeChat, we have introduced the concept of **assistants**. An assistant is a complete functional module, each with its own responsibilities and tasks. Assistants can help you handle various tasks and provide professional advice and guidance. +Therefore, in LobeChat, we have introduced the concept of **Agents**. An agent is a complete functional module, each with its own responsibilities and tasks. Assistants can help you handle various tasks and provide professional advice and guidance. -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279602489-89893e61-2791-4083-9b57-ed80884ad58b.png) +{'Topics -At the same time, we have integrated topics into each assistant. The benefit of this approach is that each assistant has an independent topic list. You can choose the corresponding assistant based on the current task and quickly switch between historical conversation records. This method is more in line with users' habits in common chat software, improving interaction efficiency. +At the same time, we have integrated topics into each agent. The benefit of this approach is that each agent has an independent topic list. You can choose the corresponding agent based on the current task and quickly switch between historical conversation records. This method is more in line with users' habits in common chat software, improving interaction efficiency. diff --git a/docs/usage/agents/concepts.zh-CN.mdx b/docs/usage/agents/concepts.zh-CN.mdx index f9664252943a9..4136fe1705db7 100644 --- a/docs/usage/agents/concepts.zh-CN.mdx +++ b/docs/usage/agents/concepts.zh-CN.mdx @@ -4,7 +4,7 @@ 在 ChatGPT 官方应用中，只存在话题的概念，如图所示，在侧边栏中是用户的历史对话话题列表。 -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279602474-fe7cb3f3-8eb7-40d3-a69f-6615393bbd4e.png) +{'ChatGPT 但在我们的使用过程中其实会发现这种模式存在很多问题，比如历史对话的信息索引过于分散问题，同时当处理一些重复任务时很难有一个稳定的入口，比如我希望有一个稳定的入口可以让 ChatGPT 帮助我翻译文档，在这个模式下，我需要不断新建新的话题同时再设置我之前创建好的翻译 Prompt 设定，当有高频任务存在时，这将是一个效率很低的交互形式。 @@ -12,6 +12,6 @@ 因此在 LobeChat 中，我们引入了 **助手** 的概念。助手是一个完整的功能模块，每个助手都有自己的职责和任务。助手可以帮助你处理各种任务，并提供专业的建议和指导。 -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279602489-89893e61-2791-4083-9b57-ed80884ad58b.png) +{'「话题」与「助手」'} 与此同时，我们将话题索引到每个助手内部。这样做的好处是，每个助手都有一个独立的话题列表，你可以根据当前任务选择对应的助手，并快速切换历史对话记录。这种方式更符合用户对常见聊天软件的使用习惯，提高了交互的效率。 diff --git a/docs/usage/agents/custom-agent.mdx b/docs/usage/agents/custom-agent.mdx index 13f22381de6c9..e260c00afebef 100644 --- a/docs/usage/agents/custom-agent.mdx +++ b/docs/usage/agents/custom-agent.mdx @@ -1,5 +1,3 @@ -import { Callout, Cards } from 'nextra/components'; - # Custom Assistant Guide As the basic functional unit of LobeChat, adding and iterating assistants is very important. Now you can add assistants to your favorites list in two ways. @@ -8,20 +6,27 @@ As the basic functional unit of LobeChat, adding and iterating assistants is ver If you are a beginner in Prompt writing, you might want to browse the assistant market of LobeChat first. Here, you can find commonly used assistants submitted by others and easily add them to your list with just one click, which is very convenient. -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279588466-4c32041b-a8e6-4703-ba4a-f91b7800e359.png) +{'Add ## `B` Create a custom assistant When you need to handle specific tasks, you need to consider creating a custom assistant to help you solve the problem. You can add and configure the assistant in detail in the following ways. -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279587283-a3ea8dfd-70fb-47ee-ab00-e3911ac6a939.png) ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279587292-a3d102c6-f61e-4578-91f1-c0a4c97588e1.png) + + {'Create + + {'Create + - - **Quick Setup Tip**: You can conveniently modify the Prompt through the quick edit button in the - sidebar. + + **Quick Setup Tip**: You can conveniently modify the Prompt through the quick edit button in the sidebar. -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279587294-388d1877-193e-4a50-9fe8-8fbcc3ccefa0.png) ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279587298-333da153-13b8-4557-a0a2-cff55e7bc1c0.png) + + {'Create + + {'Create + If you want to understand Prompt writing tips and common model parameter settings, you can continue to view: diff --git a/docs/usage/agents/custom-agent.zh-CN.mdx b/docs/usage/agents/custom-agent.zh-CN.mdx index e503da7531bfb..a6214a48251e0 100644 --- a/docs/usage/agents/custom-agent.zh-CN.mdx +++ b/docs/usage/agents/custom-agent.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Callout, Cards } from 'nextra/components'; - # 自定义助手指南 作为 LobeChat 的基础职能单位，助手的添加和迭代是非常重要的。现在你可以通过两种方式将助手添加到你的常用列表中 @@ -8,19 +6,27 @@ import { Callout, Cards } from 'nextra/components'; 如果你是一个 Prompt 编写的新手，不妨先浏览一下 LobeChat 的助手市场。在这里，你可以找到其他人提交的常用助手，并且只需一键添加到你的列表中，非常方便。 -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279588466-4c32041b-a8e6-4703-ba4a-f91b7800e359.png) +{'通过角色市场添加'} ## `B` 通过新建自定义助手 当你需要处理一些特定的任务时，你就需要考虑创建一个自定义助手来帮助你解决问题。可以通过以下方式添加并进行助手的详细配置 -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279587283-a3ea8dfd-70fb-47ee-ab00-e3911ac6a939.png) ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279587292-a3d102c6-f61e-4578-91f1-c0a4c97588e1.png) + + {'通过新建自定义助手 + + {'通过新建自定义助手 + - + **快捷设置技巧**: 可以通过侧边栏的快捷编辑按钮进行 Prompt 的便捷修改 -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279587294-388d1877-193e-4a50-9fe8-8fbcc3ccefa0.png) ![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279587298-333da153-13b8-4557-a0a2-cff55e7bc1c0.png) + + {'通过新建自定义助手 + + {'通过新建自定义助手 + 如果你希望理解 Prompt 编写技巧和常见的模型参数设置，可以继续查看： diff --git a/docs/usage/agents/model.mdx b/docs/usage/agents/model.mdx index ccef2f7635336..f5d60e7389048 100644 --- a/docs/usage/agents/model.mdx +++ b/docs/usage/agents/model.mdx @@ -3,8 +3,6 @@ title: LLM Guide description: Explore the capabilities of ChatGPT models from gpt-3.5-turbo to gpt-4-32k, understanding their speed, context limits, and cost. Learn about model parameters like temperature and top-p for better output. --- -import { Callout } from 'nextra/components'; - # Model Guide ## ChatGPT @@ -37,10 +35,10 @@ This parameter controls the randomness of the model's output. The higher the val ### `top_p` -Top_p is also a sampling parameter, but it differs from temperature in its sampling method. Before outputting, the model generates a bunch of tokens, and these tokens are ranked based on their quality. In the top-p sampling mode, the candidate word list is dynamic, and tokens are selected from the tokens based on a percentage. Top_p introduces randomness in token selection, allowing other high-scoring tokens to have a chance of being selected, rather than always choosing the highest-scoring one. +Top\_p is also a sampling parameter, but it differs from temperature in its sampling method. Before outputting, the model generates a bunch of tokens, and these tokens are ranked based on their quality. In the top-p sampling mode, the candidate word list is dynamic, and tokens are selected from the tokens based on a percentage. Top\_p introduces randomness in token selection, allowing other high-scoring tokens to have a chance of being selected, rather than always choosing the highest-scoring one. - Top_p is similar to randomness, and it is generally not recommended to change it together with the + Top\_p is similar to randomness, and it is generally not recommended to change it together with the randomness of temperature. diff --git a/docs/usage/agents/model.zh-CN.mdx b/docs/usage/agents/model.zh-CN.mdx index fd30345d420b1..9927b31812724 100644 --- a/docs/usage/agents/model.zh-CN.mdx +++ b/docs/usage/agents/model.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # 模型指南 ## ChatGPT @@ -31,9 +29,9 @@ LLM 看似很神奇，但本质还是一个概率问题，神经网络根据输 ### `top_p` -核采样 top_p 也是采样参数，跟 temperature 不一样的采样方式。模型在输出之前，会生成一堆 token，这些 token 根据质量高低排名，核采样模式中候选词列表是动态的，从 tokens 里按百分比选择候选词。 top_p 为选择 token 引入了随机性，让其他高分的 token 有被选择的机会，不会总是选最高分的。 +核采样 top\_p 也是采样参数，跟 temperature 不一样的采样方式。模型在输出之前，会生成一堆 token，这些 token 根据质量高低排名，核采样模式中候选词列表是动态的，从 tokens 里按百分比选择候选词。 top\_p 为选择 token 引入了随机性，让其他高分的 token 有被选择的机会，不会总是选最高分的。 -top_p 与随机性类似，一般来说不建议和随机性 temperature 一起更改 +top\_p 与随机性类似，一般来说不建议和随机性 temperature 一起更改
diff --git a/docs/usage/agents/prompt.mdx b/docs/usage/agents/prompt.mdx index 3859501f1c166..e16bfa8733458 100644 --- a/docs/usage/agents/prompt.mdx +++ b/docs/usage/agents/prompt.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # Guide to Using Prompts ## Basic Concepts of Prompts @@ -8,7 +6,7 @@ Generative AI is very useful, but it requires human guidance. In most cases, gen ## How to Write a Well-Structured Prompt - + A structured prompt refers to the construction of the prompt having a clear logic and structure. For example, if you want the model to generate an article, your prompt may need to include the article's topic, outline, and style. @@ -37,7 +35,7 @@ The second prompt generates longer output and better structure. The use of the t ## How to Improve Quality and Effectiveness - + There are several ways to improve the quality and effectiveness of prompts: - **Be Clear About Your Needs:** The model's output will strive to meet your needs, so if your needs are not clear, the output may not meet expectations. diff --git a/docs/usage/agents/prompt.zh-CN.mdx b/docs/usage/agents/prompt.zh-CN.mdx index af448fa0be1f9..7931d59e70187 100644 --- a/docs/usage/agents/prompt.zh-CN.mdx +++ b/docs/usage/agents/prompt.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # Prompt 使用指南 ## Prompt 基本概念 @@ -8,7 +6,7 @@ import { Callout } from 'nextra/components'; ## 如何写好一个结构化 prompt - + 结构化 prompt 是指 prompt 的构造应该有明确的逻辑和结构。例如，如果你想让模型生成一篇文章，你的 prompt 可能需要包括文章的主题，文章的大纲，文章的风格等信息。 @@ -38,7 +36,7 @@ import { Callout } from 'nextra/components'; ## 如何提升其质量和效果 - + 提升 prompt 质量和效果的方法主要有以下几点： - **尽量明确你的需求：** 模型的输出会尽可能满足你的需求，所以如果你的需求不明确，输出可能会不如预期。 diff --git a/docs/usage/agents/topics.mdx b/docs/usage/agents/topics.mdx index 1fa6b1166da68..0e9f4e0bcdf04 100644 --- a/docs/usage/agents/topics.mdx +++ b/docs/usage/agents/topics.mdx @@ -1,6 +1,6 @@ # Topic Usage Guide -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279602496-fd72037a-735e-4cc2-aa56-2994bceaba81.png) +{'Topic - **Save Topic:** During a conversation, if you want to save the current context and start a new topic, you can click the save button next to the send button. - **Topic List:** Clicking on a topic in the list allows for quick switching of historical conversation records and continuing the conversation. You can also use the star icon ⭐️ to pin favorite topics to the top, or use the more button on the right to rename or delete topics. diff --git a/docs/usage/agents/topics.zh-CN.mdx b/docs/usage/agents/topics.zh-CN.mdx index bd9934f980f36..1d00e49bcff17 100644 --- a/docs/usage/agents/topics.zh-CN.mdx +++ b/docs/usage/agents/topics.zh-CN.mdx @@ -1,6 +1,6 @@ # 话题使用指南 -![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279602496-fd72037a-735e-4cc2-aa56-2994bceaba81.png) +{'话题使用指南'} - **保存话题：** 在聊天过程中，如果想要保存当前上下文并开启新的话题，可以点击发送按钮旁边的保存按钮。 - **话题列表：** 点击列表中的话题可以快速切换历史对话记录，并继续对话。你还可以通过点击星标图标 ⭐️ 将话题收藏置顶，或者通过右侧更多按钮对话题进行重命名和删除操作。 diff --git a/docs/usage/features/agent-market.mdx b/docs/usage/features/agent-market.mdx index 7dda16849541b..d6e7c3fc85b37 100644 --- a/docs/usage/features/agent-market.mdx +++ b/docs/usage/features/agent-market.mdx @@ -2,12 +2,11 @@ title: Assistant Market --- -import { Callout } from 'nextra/components'; - # Assistant Market {'Assistant - By [🤖/🏪 submitting agents][submit-agents-link], you can easily submit your assistant works to + + By [🤖/🏪 submitting agents](https://github.com/lobehub/lobe-chat-agents), you can easily submit your assistant works to our platform. We particularly emphasize that LobeChat has established a sophisticated automated internationalization (i18n) workflow, which excels in seamlessly converting your assistants into multiple language versions. This means that regardless of the language your users are using, they can seamlessly experience your assistant. - + We welcome all users to join this ever-growing ecosystem and participate in the iteration and optimization of assistants. Together, let's create more interesting, practical, and innovative assistants, further enriching the diversity and practicality of assistants. - -## Assistant Examples - -| Recently Added | Assistant Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [Copywriting](https://chat-preview.lobehub.com/market?agent=copywriting)
By **[pllz7](https://github.com/pllz7)** on **2024-02-14** | Proficient in persuasive copywriting and consumer psychology
`E-commerce` | -| [Private Domain Operation Expert](https://chat-preview.lobehub.com/market?agent=gl-syyy)
By **[guling-io](https://github.com/guling-io)** on **2024-02-14** | Proficient in private domain operation, traffic acquisition, conversion, and content planning, familiar with marketing theories and related classic works.
`Private domain operation` `Traffic acquisition` `Conversion` `Content planning` | -| [Self-media Operation Expert](https://chat-preview.lobehub.com/market?agent=gl-zmtyy)
By **[guling-io](https://github.com/guling-io)** on **2024-02-14** | Proficient in self-media operation and content creation
`Self-media operation` `Social media` `Content creation` `Fan growth` `Brand promotion` | -| [Product Description](https://chat-preview.lobehub.com/market?agent=product-description)
By **[pllz7](https://github.com/pllz7)** on **2024-02-14** | Create captivating product descriptions to improve e-commerce sales performance
`E-commerce` | - -> 📊 Total agents: [**177** ](https://github.com/lobehub/lobe-chat-agents) - -[submit-agents-link]: https://github.com/lobehub/lobe-chat-agents diff --git a/docs/usage/features/agent-market.zh-CN.mdx b/docs/usage/features/agent-market.zh-CN.mdx index dbfdd5e16a042..fb41495fa3bab 100644 --- a/docs/usage/features/agent-market.zh-CN.mdx +++ b/docs/usage/features/agent-market.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # 助手市场 - 通过 [🤖/🏪 提交助手][submit-agents-link] + + 通过 [🤖/🏪 提交助手](https://github.com/lobehub/lobe-chat-agents) ，你可以轻松地将你的助手作品提交到我们的平台。我们特别强调的是，LobeChat 建立了一套精密的自动化国际化（i18n）工作流程， 它的强大之处在于能够无缝地将你的助手转化为多种语言版本。这意味着，不论你的用户使用何种语言，他们都能无障碍地体验到你的助手。 - + 我们欢迎所有用户加入这个不断成长的生态系统，共同参与到助手的迭代与优化中来。共同创造出更多有趣、实用且具有创新性的助手，进一步丰富助手的多样性和实用性。 - -## 助手示例 - -| 最近新增 | 助手说明 | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [产品文案撰写](https://chat-preview.lobehub.com/market?agent=copywriting)
By **[pllz7](https://github.com/pllz7)** on **2024-02-14** | 精通有说服力的文案撰写和消费者心理学
`电子商务` | -| [私域运营专家](https://chat-preview.lobehub.com/market?agent=gl-syyy)
By **[guling-io](https://github.com/guling-io)** on **2024-02-14** | 擅长私域运营、引流、承接、转化和内容策划，熟悉营销理论和相关经典著作。
`私域运营` `引流` `承接` `转化` `内容策划` | -| [自媒体运营专家](https://chat-preview.lobehub.com/market?agent=gl-zmtyy)
By **[guling-io](https://github.com/guling-io)** on **2024-02-14** | 擅长自媒体运营与内容创作
`自媒体运营` `社交媒体` `内容创作` `粉丝增长` `品牌推广` | -| [产品描述](https://chat-preview.lobehub.com/market?agent=product-description)
By **[pllz7](https://github.com/pllz7)** on **2024-02-14** | 打造引人入胜的产品描述，提升电子商务销售业绩
`电子商务` | - -> 📊 Total agents: [**177** ](https://github.com/lobehub/lobe-chat-agents) - -[submit-agents-link]: https://github.com/lobehub/lobe-chat-agents diff --git a/docs/usage/features/local-llm.mdx b/docs/usage/features/local-llm.mdx index 5101ef4a7851f..e57eeff5e5273 100644 --- a/docs/usage/features/local-llm.mdx +++ b/docs/usage/features/local-llm.mdx @@ -3,11 +3,9 @@ title: Local LLM image: https://github.com/lobehub/lobe-chat/assets/28616219/8292b22e-1f4f-478b-b510-32c7883c1c6d --- -import { Callout } from 'nextra/components'; - # Local Large Language Model (LLM) Support -{'Ollama +{'Ollama Available in >=0.127.0, currently only supports Docker deployment diff --git a/docs/usage/features/local-llm.zh-CN.mdx b/docs/usage/features/local-llm.zh-CN.mdx index fc523befe7e5a..b1e41d522384f 100644 --- a/docs/usage/features/local-llm.zh-CN.mdx +++ b/docs/usage/features/local-llm.zh-CN.mdx @@ -5,11 +5,9 @@ image: https://github.com/lobehub/lobe-chat/assets/28616219/8292b22e-1f4f-478b-b tags: 本地大语言模型,LLM,LobeChat v0.127.0,Ollama AI,Docker 部署 --- -import { Callout } from 'nextra/components'; - # 支持本地大语言模型（LLM） -{'Ollama +{'Ollama 在 >=v0.127.0 版本中可用，目前仅支持 Docker 部署 diff --git a/docs/usage/features/more.mdx b/docs/usage/features/more.mdx index b4ba05897d870..b4215274e4b49 100644 --- a/docs/usage/features/more.mdx +++ b/docs/usage/features/more.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # More Features In addition to the above features, our design and technical capabilities will provide you with more assurance in usage: diff --git a/docs/usage/features/more.zh-CN.mdx b/docs/usage/features/more.zh-CN.mdx index a94f2761ae7c1..64d7900a0f2d6 100644 --- a/docs/usage/features/more.zh-CN.mdx +++ b/docs/usage/features/more.zh-CN.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # 更多特性 除了上述功能特性以外，我们的所具有的设计和技术能力将为你带来了更多使用保障： diff --git a/docs/usage/features/multi-ai-providers.mdx b/docs/usage/features/multi-ai-providers.mdx index e6548e20f7b99..95622b70cd6aa 100644 --- a/docs/usage/features/multi-ai-providers.mdx +++ b/docs/usage/features/multi-ai-providers.mdx @@ -2,11 +2,9 @@ title: Multi AI Providers --- -import { Callout } from 'nextra/components'; - # Multi-Model Service Provider Support -{'Multi-Model +{'Multi-Model Available in version 0.123.0 and later @@ -27,6 +25,6 @@ At the same time, we are also planning to support more model service providers, ## Local Model Support -![](https://github.com/lobehub/lobe-chat/assets/28616219/ca9a21bc-ea6c-4c90-bf4a-fa53b4fb2b5c) +{'Local To meet the specific needs of users, LobeChat also supports the use of local models based on [Ollama](https://ollama.ai), allowing users to flexibly use their own or third-party models. For more details, see [Local Model Support](/en/usage/features/local-llm). diff --git a/docs/usage/features/multi-ai-providers.zh-CN.mdx b/docs/usage/features/multi-ai-providers.zh-CN.mdx index 5d5e1fec7e438..b68810e2ae5b5 100644 --- a/docs/usage/features/multi-ai-providers.zh-CN.mdx +++ b/docs/usage/features/multi-ai-providers.zh-CN.mdx @@ -1,8 +1,6 @@ -import { Callout } from 'nextra/components'; - # 多模型服务商支持 -{'多模型服务商支持'} +{'多模型服务商支持'} 在 0.123.0 及以后版本中可用 @@ -23,6 +21,6 @@ import { Callout } from 'nextra/components'; ## 本地模型支持 -![](https://github.com/lobehub/lobe-chat/assets/28616219/ca9a21bc-ea6c-4c90-bf4a-fa53b4fb2b5c) +{'本地模型支持'} 为了满足特定用户的需求，LobeChat 还基于 [Ollama](https://ollama.ai) 支持了本地模型的使用，让用户能够更灵活地使用自己的或第三方的模型，详见 [本地模型支持](/zh/usage/features/local-llm)。 diff --git a/docs/usage/features/plugin-system.mdx b/docs/usage/features/plugin-system.mdx index 8b8d9e33bb5fc..9453e434d7298 100644 --- a/docs/usage/features/plugin-system.mdx +++ b/docs/usage/features/plugin-system.mdx @@ -2,12 +2,11 @@ title: Plugin System --- -import { Callout, Steps } from 'nextra/components'; - # Plugin System {'Plugin + To help developers better participate in this ecosystem, we provide comprehensive development resources. This includes detailed component development documentation, a fully-featured software development kit (SDK), and template examples, all aimed at simplifying the development process and lowering the entry barrier for developers. - + We welcome developers to utilize these resources, unleash their creativity, and write feature-rich, user-friendly plugins. Through collective efforts, we can continuously expand the functional boundaries of the chat application and explore a more intelligent and efficient creativity platform. -📊 Total plugins: [**61**](https://github.com/lobehub/lobe-chat-plugins) - -| Recently Added | Plugin Description | -| ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Charts and Graphs](https://chat-preview.lobehub.com/settings/agent)
By **pyxl** on **2024-02-05** | Mermaid charts, presentation schemes, analysis, research websites, pie charts.
`Charts` `Graphs` | -| [Social Search](https://chat-preview.lobehub.com/settings/agent)
By **say-apps** on **2024-02-02** | Social search provides access to tweets, users, followers, images, media, and more.
`Social` `Twitter` `x` `Search` | -| [TokenInsights](https://chat-preview.lobehub.com/settings/agent)
By **feednews** on **2024-01-27** | Get real-time cryptocurrency prices, BTC, ETH, BNB, and the latest insights. The latest coin news and airdrop opportunities.
`Cryptocurrency` `btc` `eth` `bnb` | -| [Bilibili](https://chat-preview.lobehub.com/settings/agent)
By **LobeHub** on **2024-01-27** | Experience Bilibili's rich content through keyword video search, replay access, interactive barrage, popular video recommendations, and hot search insights, all at your fingertips.
`Video` `Bilibili` `Search` | - ## Plugin Ecosystem diff --git a/docs/usage/features/plugin-system.zh-CN.mdx b/docs/usage/features/plugin-system.zh-CN.mdx index 69b6ecf52a84d..7aef3f074aefd 100644 --- a/docs/usage/features/plugin-system.zh-CN.mdx +++ b/docs/usage/features/plugin-system.zh-CN.mdx @@ -1,9 +1,8 @@ -import { Callout, Steps } from 'nextra/components'; - # 插件系统 {'插件系统'} + 为了帮助开发者更好地参与到这个生态中来，我们在提供了全面的开发资源。这包括详尽的组件开发文档、功能齐全的软件开发工具包（SDK），以及样板示例，这些都是为了简化开发过程，降低开发者的入门门槛。 - + 我们欢迎开发者利用这些资源，发挥创造力，编写出功能丰富、用户友好的插件。通过共同的努力，我们可以不断扩展聊天应用的功能界限，探索一个更加智能、高效的创造力平台。 -📊 Total plugins: [**61**](https://github.com/lobehub/lobe-chat-plugins) - -| 最近新增 | 插件描述 | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| [图表和图示](https://chat-preview.lobehub.com/settings/agent)
By **pyxl** on **2024-02-05** | 美人鱼图表，演示文稿方案，分析，研究网站，饼图。
`图表` `图示` | -| [社交搜索](https://chat-preview.lobehub.com/settings/agent)
By **say-apps** on **2024-02-02** | 社交搜索提供访问推文、用户、关注者、图片、媒体等功能。
`社交` `推特` `x` `搜索` | -| [TokenInsights](https://chat-preview.lobehub.com/settings/agent)
By **feednews** on **2024-01-27** | 获取实时加密货币价格，BTC，ETH，BNB 和最新见解。最新的币新闻和空投机会。
`加密货币` `btc` `eth` `bnb` | -| [哔哩哔哩](https://chat-preview.lobehub.com/settings/agent)
By **LobeHub** on **2024-01-27** | 通过关键词视频搜索、回放访问、互动弹幕、热门视频推荐和热搜洞察等功能，深入体验哔哩哔哩丰富的内容，尽在您的指尖。
`视频` `哔哩哔哩` `搜索` | - ## 插件生态体系 diff --git a/docs/usage/features/pwa.mdx b/docs/usage/features/pwa.mdx index 864ba5be8b60d..6be7f464cf8ff 100644 --- a/docs/usage/features/pwa.mdx +++ b/docs/usage/features/pwa.mdx @@ -2,11 +2,9 @@ title: Progressive Web Apps (PWA) --- -import { Steps } from 'nextra/components'; - # Progressive Web App (PWA) -{'Progressive +{'Progressive We understand the importance of providing a seamless experience for users in today's multi-device environment. To achieve this, we have adopted Progressive Web App [PWA](https://support.google.com/chrome/answer/9658361) technology, which is a modern web technology that elevates web applications to a near-native app experience. Through PWA, LobeChat is able to provide a highly optimized user experience on both desktop and mobile devices, while maintaining lightweight and high performance characteristics. Visually and perceptually, we have also carefully designed it to ensure that its interface is indistinguishable from a native app, providing smooth animations, responsive layouts, and adaptation to different screen resolutions of various devices. diff --git a/docs/usage/features/pwa.zh-CN.mdx b/docs/usage/features/pwa.zh-CN.mdx index df087d8892496..10351ff0ce1c9 100644 --- a/docs/usage/features/pwa.zh-CN.mdx +++ b/docs/usage/features/pwa.zh-CN.mdx @@ -1,8 +1,6 @@ -import { Steps } from 'nextra/components'; - # 渐进式 Web 应用（PWA） -{'渐进式 +{'渐进式 我们利深知在当今多设备环境下为用户提供无缝体验的重要性。为此，我们采用了渐进式 Web 应用 [PWA](https://support.google.com/chrome/answer/9658361) 技术，这是一种能够将网页应用提升至接近原生应用体验的现代 Web 技术。通过 PWA，LobeChat 能够在桌面和移动设备上提供高度优化的用户体验，同时保持轻量级和高性能的特点。在视觉和感觉上，我们也经过精心设计，以确保它的界面与原生应用无差别，提供流畅的动画、响应式布局和适配不同设备的屏幕分辨率。 diff --git a/docs/usage/features/text-to-image.mdx b/docs/usage/features/text-to-image.mdx index 7ca77933be3f3..797cf356baa9d 100644 --- a/docs/usage/features/text-to-image.mdx +++ b/docs/usage/features/text-to-image.mdx @@ -6,6 +6,7 @@ title: Text to Image {'Text +{'Custom LobeChat places a strong emphasis on personalized user experiences in its interface design, and thus introduces flexible and diverse theme modes, including a light mode for daytime and a dark mode for nighttime. In addition to theme mode switching, we also provide a series of color customization options, allowing users to adjust the application's theme colors according to their preferences. Whether it's a stable deep blue, a lively peach pink, or a professional gray and white, users can find color choices in LobeChat that match their own style. - + The default configuration can intelligently identify the user's system color mode and automatically switch themes to ensure a consistent visual experience with the operating system. diff --git a/docs/usage/features/theme.zh-CN.mdx b/docs/usage/features/theme.zh-CN.mdx index c37655f853a8b..2ecc7f9c61db5 100644 --- a/docs/usage/features/theme.zh-CN.mdx +++ b/docs/usage/features/theme.zh-CN.mdx @@ -1,14 +1,12 @@ -import { Callout } from 'nextra/components'; - # 自定义主题 -{'自定义主题'} +{'自定义主题'} LobeChat 在界面设计上十分考虑用户的个性化体验，因此引入了灵活多变的主题模式，其中包括日间的亮色模式和夜间的深色模式。 除了主题模式的切换，我们还提供了一系列的颜色定制选项，允许用户根据自己的喜好来调整应用的主题色彩。无论是想要沉稳的深蓝，还是希望活泼的桃粉，或者是专业的灰白，用户都能够在 LobeChat 中找到匹配自己风格的颜色选择。 - + 默认配置能够智能地识别用户系统的颜色模式，自动进行主题切换，以确保应用界面与操作系统保持一致的视觉体验。 diff --git a/docs/usage/features/tts.mdx b/docs/usage/features/tts.mdx index 17f7190d584e2..274edbc0f9587 100644 --- a/docs/usage/features/tts.mdx +++ b/docs/usage/features/tts.mdx @@ -6,6 +6,7 @@ title: Speech Synthesis and Recognition (TTS & STT) {'TTS -[@lobehub/tts](https://tts.lobehub.com) is a high-quality TTS toolkit developed using the TS language, supporting usage in both server and browser environments. +[`@lobehub/tts`](https://tts.lobehub.com) is a high-quality TTS toolkit developed using the TS language, supporting usage in both server and browser environments. - **Server**: With just 15 lines of code, it can achieve high-quality speech generation capabilities comparable to OpenAI TTS services. It currently supports EdgeSpeechTTS, MicrosoftTTS, OpenAITTS, and OpenAISTT. - **Browser**: It provides high-quality React Hooks and visual audio components, supporting common functions such as loading, playing, pausing, and dragging the timeline, and offering extensive audio track style adjustment capabilities. diff --git a/docs/usage/features/tts.zh-CN.mdx b/docs/usage/features/tts.zh-CN.mdx index f21e163c93379..24bda76cd1280 100644 --- a/docs/usage/features/tts.zh-CN.mdx +++ b/docs/usage/features/tts.zh-CN.mdx @@ -1,9 +1,8 @@ -import { Callout } from 'nextra/components'; - # TTS & STT 语音会话 {'TTS -[@lobehub/tts](https://tts.lobehub.com) 是一个使用 TS 语言开发的，高质量 TTS 工具包，支持在服务端和浏览器中使用。 +[`@lobehub/tts`](https://tts.lobehub.com) 是一个使用 TS 语言开发的，高质量 TTS 工具包，支持在服务端和浏览器中使用。 - **服务端**：只要使用 15 行代码，即可实现对标 OpenAI TTS 服务的高质量语音生成能力。目前支持 EdgeSpeechTTS 与 MicrosoftTTS 与 OpenAITTS、OpenAISTT。 - **浏览器**：提供了高质量的 React Hooks 与可视化音频组件，支持加载、播放、暂停、拖动时间轴等常用功能，且提供了非常丰富的音轨样式调整能力。 diff --git a/docs/usage/features/vision.mdx b/docs/usage/features/vision.mdx index 2b3b29a216f96..c8a18047a4e03 100644 --- a/docs/usage/features/vision.mdx +++ b/docs/usage/features/vision.mdx @@ -6,6 +6,7 @@ title: Vision Recognition {'Model +