update docs

Author: wu-clan

docs/.vuepress/components/BannerTop.vue

@@ -15,7 +15,7 @@
     </button>
     <p class="vp-banner-text vp-coupon">
       <span class="vp-text-primary">代码有 BUG？</span>
-      <span> 快通过互动与我们反馈吧</span>
+      <span> 快通过交流群与我们反馈吧</span>
     </p>
   </div>
 </template>

docs/.vuepress/navbar.ts

@@ -180,7 +180,7 @@ export const myNavbar: ThemeNavItem[] = defineNavbarConfig([
                         text: '插件市场',
                         icon: 'mdi:marketplace-outline',
                         // badge: { text: 'HOT', type: 'danger' },
-                        link: '/market'
+                        link: '/marketplace'
                     },
                 ]
             }

docs/.vuepress/styles/custom.css

@@ -45,35 +45,11 @@
     transform: translateX(-50%);
     font-size: 16px;
     font-weight: bold;
-    color: #d91a7a;
+    color: #ff6b9d;
     white-space: nowrap;
     padding: 6px 12px;
-    filter: drop-shadow(0 0 3px rgba(217, 26, 122, 0.4)) drop-shadow(0 0 8px rgba(217, 26, 122, 0.7)) drop-shadow(0 0 15px rgba(217, 26, 122, 1));
-    animation: neon-glow-flicker-light 3s ease-in-out infinite;
-}
-
-[data-theme="dark"] .hero-content::before {
-    color: #ff6b9d;
     filter: drop-shadow(0 0 3px rgba(255, 107, 157, 0.4)) drop-shadow(0 0 8px rgba(255, 107, 157, 0.7)) drop-shadow(0 0 15px rgba(255, 107, 157, 1));
-    animation: neon-glow-flicker-dark 3s ease-in-out infinite;
-}
-
-@keyframes neon-glow-flicker-light {
-    0%, 18%, 22%, 25%, 53%, 57%, 100% {
-        filter: drop-shadow(0 0 3px rgba(217, 26, 122, 0.4)) drop-shadow(0 0 8px rgba(217, 26, 122, 0.7)) drop-shadow(0 0 15px rgba(217, 26, 122, 1));
-    }
-    20%, 24%, 55% {
-        filter: drop-shadow(0 0 2px rgba(217, 26, 122, 0.3)) drop-shadow(0 0 5px rgba(217, 26, 122, 0.6)) drop-shadow(0 0 10px rgba(217, 26, 122, 0.9));
-    }
-}
-
-@keyframes neon-glow-flicker-dark {
-    0%, 18%, 22%, 25%, 53%, 57%, 100% {
-        filter: drop-shadow(0 0 3px rgba(255, 107, 157, 0.4)) drop-shadow(0 0 8px rgba(255, 107, 157, 0.7)) drop-shadow(0 0 15px rgba(255, 107, 157, 1));
-    }
-    20%, 24%, 55% {
-        filter: drop-shadow(0 0 2px rgba(255, 107, 157, 0.3)) drop-shadow(0 0 5px rgba(255, 107, 157, 0.6)) drop-shadow(0 0 10px rgba(255, 107, 157, 0.9));
-    }
+    animation: neon-glow-flicker-light 3s ease-in-out infinite;
 }
 
 /* 首页非全屏样式 */
@@ -92,6 +68,11 @@
     border-radius: 10px !important;
 }
 
+.vp-button.sponsor {
+    background-color: var(--vp-button-alt-bg) !important;
+    border: 2px solid var(--vp-c-brand-1) !important;
+}
+
 /* 首页全屏时向下的箭头 */
 .vp-sign-down {
     color: var(--vp-c-brand-1) !important;

docs/README.md

@@ -18,7 +18,7 @@ config:
           text: 快速上手 ->
           link: /backend/summary/quick-start
         - theme: sponsor
-          text: 在线体验
+          text: 在线体验 ->
           link: https://fba.wu-clan.site/
         - theme: alt
           text: 伪三层架构?

docs/plugin/dev.md

@@ -57,6 +57,8 @@ fba 会在每次启动前对所有插件进行实时解析
 ```toml
 # 插件信息
 [plugin]
+# 图标（插件仓库内的图标路径或图标链接地址）
+icon = 'assets/icon.svg'
 # 摘要（简短描述）
 summary = ''
 # 版本号
@@ -65,19 +67,33 @@ version = ''
 description = ''
 # 作者
 author = ''
+# 标签
+# 当前支持：ai、mcp、agent、rag、permission、sso、rbac、auth、ldap、
+# storage、notification、task、other
+tags = ['']
+# 数据库支持
+# 当前支持：mysql、pgsql、postgresql
+database = ['']
 
 # 应用配置
 [app]
 # 路由器最终实例
 # 可参考源码：backend/app/admin/api/router.py，通常默认命名为 v1
 router = ['v1']
+
+# 代码中的配置项（全大写）
+# 该配置项为可选，详情请查看：热插拔
+[settings]
+XXX = X
 ```
 
 @tab <Icon name="fluent:table-simple-include-16-regular" />扩展级插件
 
 ```toml
 # 插件信息
 [plugin]
+# 图标（插件仓库内的图标路径或图标链接地址）
+icon = 'assets/icon.svg'
 # 摘要（简短描述）
 summary = ''
 # 版本号
@@ -86,6 +102,13 @@ version = ''
 description = ''
 # 作者
 author = ''
+# 标签
+# 当前支持：ai、mcp、agent、rag、permission、sso、rbac、auth、ldap、
+# storage、notification、task、other
+tags = ['']
+# 数据库支持
+# 当前支持：mysql、pgsql、postgresql
+database = ['']
 
 # 应用配置
 [app]
@@ -101,6 +124,11 @@ extend = '应用文件夹名称'
 prefix = ''
 # 标签，用于 Swagger 文档
 tags = ''
+
+# 代码中的配置项（全大写）
+# 该配置项为可选，详情请查看：热插拔
+[settings]
+XXX = X
 ```
 
 :::
@@ -133,6 +161,7 @@ fba 内所有官方实现都同时兼容 mysql 和 postgresql，但我们不对
             - init.sql 自增 id 模式
             - init_snowflake.sql 雪花 id 模式
     - utils/ 工具包
+    - .env.example 环境变量
     - __init__.py 作为 python 包保留 <Badge type="danger" text="必须" />
     - … 更多内容，例如 enums.py...
     - plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
@@ -141,6 +170,62 @@ fba 内所有官方实现都同时兼容 mysql 和 postgresql，但我们不对
 
 :::
 
+### 全局配置
+
+fba 采用全局单配置文件（类似 Django），我们的标准做法是在 `backend/core/conf.py` 中统一添加插件的全局配置，示例如下：
+
+```python
+##################################################
+# [ Plugin ] email
+##################################################
+# .env
+EMAIL_USERNAME: str
+EMAIL_PASSWORD: str
+
+# 基础配置
+EMAIL_HOST: str = 'smtp.qq.com'
+EMAIL_PORT: int = 465
+EMAIL_SSL: bool = True
+EMAIL_CAPTCHA_REDIS_PREFIX: str = 'fba:email:captcha'
+EMAIL_CAPTCHA_EXPIRE_SECONDS: int = 60 * 3  # 3 分钟
+```
+
+整个结构分为【插件配置说明注释】、【插件环境变量配置及注释】、【插件基础配置及注释】，但是，在发布的插件中，我们无法添加这些配置，只能通过
+`README` 进行说明，提醒用户如何完成插件配置，可参考 fba 官方插件：[oss](https://github.com/fastapi-practices/oss)
+
+### 热插拔
+
+从 ==v1.13.0=={.warning} 开始，按以下要求进行全局配置，将自动适配热插拔特性
+
+1. 插件环境变量
+
+   如果插件需要添加环境变量，则需在插件根目录添加 `.env.example` 文件，并添加环境变量配置，参考如下：
+
+    ```dotenv:no-line-numbers
+    # [ Plugin ] email
+    EMAIL_USERNAME: str
+    EMAIL_PASSWORD: str
+    ```
+
+2. 插件基础配置
+
+   如果插件需要添加基础配置，则需在 [插件配置](#插件配置) 中的 `settings` 配置项中添加基础配置，参考如下：
+
+   ::: warning
+   `plugin.toml` 和 `backend/core/conf.py` 中的配置方式完全不同。请格外注意，避免混淆
+   :::
+
+    ```toml:no-line-numbers
+    [settings]
+    EMAIL_HOST = 'smtp.qq.com'
+    EMAIL_PORT = 465
+    EMAIL_SSL = true
+    EMAIL_CAPTCHA_REDIS_PREFIX = 'fba:email:captcha'
+    EMAIL_CAPTCHA_EXPIRE_SECONDS = 180  # 3 分钟
+    ```
+
+完成以上配置后，如果插件无需更多修改，通过 [CLI 或 Git](./install.md) 方式安装插件后，将无损适配热插拔
+
 ## 前端
 
 ::: steps

docs/plugin/install.md

@@ -12,6 +12,13 @@ title: 插件安装
 3. 根据插件说明（README.md）进行相关配置
 4. 重启服务
 
+@tab GIT
+
+1. 获取插件 git 仓库地址，理论上支持任何平台（GitHub、Gitlab、Gitee、Gitea...）
+2. 通过 fba git 插件安装接口进行安装
+3. 根据插件说明（README.md）进行相关配置
+4. 重启服务
+
 @tab ZIP
 
 1. 获取打包好的插件 zip 压缩包 <Badge type="warning" text="二选一" />
@@ -28,13 +35,6 @@ title: 插件安装
 3. 根据插件说明（README.md）进行相关配置
 4. 重启服务
 
-@tab GIT
-
-1. 获取插件 git 仓库地址，理论上支持任何平台（GitHub、Gitlab、Gitee、Gitea...）
-2. 通过 fba git 插件安装接口进行安装
-3. 根据插件说明（README.md）进行相关配置
-4. 重启服务
-
 @tab 手动
 
 1. 获取插件仓库源码并下载