📝 docs: Add documentation

2025-12-11 03:29:07 +00:00
parent 50e695a1bb
commit 99e7f6062d
135 changed files with 79115 additions and 8 deletions
@@ -0,0 +1,172 @@
+<div v-pre>
+
+# 广告管理
+
+创建和管理平台广告,支持多种广告类型和有效期控制。
+
+## 表格列说明
+
+### 状态 (Status)
+开关按钮,控制广告是否显示。
+
+### 标题 (Title)
+广告标题。
+
+### 类型 (Type)
+广告类型(Badge显示):
+- Banner横幅
+- Popup弹窗
+- Sidebar侧边栏
+- Notice通知栏
+
+### 目标链接 (Target URL)
+点击广告跳转的链接。
+
+### 描述 (Description)
+广告描述文字。
+
+### 有效期 (Validity Period)
+广告显示的时间范围:
+- 开始时间
+- 结束时间
+
+## 表格操作
+
+### 编辑
+打开侧边抽屉修改广告。
+
+### 删除
+删除广告(需确认),不可恢复。
+
+### 创建广告
+添加新的广告。
+
+## 广告表单
+
+### 标题 (必填)
+广告标题,显示给用户。
+
+### 类型 (必填)
+选择广告类型:
+- **Banner**: 顶部或底部横幅广告
+- **Popup**: 页面弹窗广告
+- **Sidebar**: 侧边栏固定广告
+- **Notice**: 通知栏滚动广告
+
+### 目标链接 (可选)
+点击广告跳转的URL:
+- 外部链接: https://example.com
+- 内部页面: /pricing
+- 留空则不可点击
+
+### 描述 (可选)
+广告描述或详细内容。
+
+### 图片URL (可选,部分类型需要)
+广告图片地址:
+- Banner和Popup通常需要图片
+- 使用外链图片
+- 建议尺寸: Banner 1920x200, Popup 800x600
+
+### 有效期 (必填)
+设置广告显示的时间范围:
+- 开始时间: 广告开始显示
+- 结束时间: 广告停止显示
+- 可以提前创建定时广告
+
+### 状态 (默认禁用)
+控制广告是否立即显示:
+- 创建时默认禁用
+- 启用后在有效期内显示
+
+## 筛选功能
+
+### 状态筛选
+选择"启用"或"禁用"查看对应广告。
+
+### 关键词搜索
+搜索广告标题。
+
+## 使用场景
+
+### 场景一: 创建促销横幅
+
+**表单配置**:
+- 标题: 双十一特惠活动
+- 类型: Banner
+- 目标链接: /pricing
+- 描述: 全场套餐8折优惠
+- 图片URL: https://cdn.example.com/banner-1111.jpg
+- 有效期:
+  - 开始: 2024-11-11 00:00
+  - 结束: 2024-11-11 23:59
+- 状态: 启用
+
+### 场景二: 创建弹窗公告
+
+**表单配置**:
+- 标题: 重要系统升级通知
+- 类型: Popup
+- 目标链接: /announcement/123
+- 描述: 系统将于今晚22:00-23:00进行维护升级...
+- 图片URL: https://cdn.example.com/popup-upgrade.jpg
+- 有效期:
+  - 开始: 2024-01-15 08:00
+  - 结束: 2024-01-15 23:00
+- 状态: 启用
+
+### 场景三: 创建侧边栏推广
+
+**表单配置**:
+- 标题: 推荐好友返佣
+- 类型: Sidebar
+- 目标链接: /invite
+- 描述: 邀请好友注册,获得10%返佣
+- 图片URL: https://cdn.example.com/sidebar-invite.jpg
+- 有效期:
+  - 开始: 2024-01-01 00:00
+  - 结束: 2024-12-31 23:59
+- 状态: 启用
+
+### 场景四: 创建通知栏滚动
+
+**表单配置**:
+- 标题: 新节点上线
+- 类型: Notice
+- 目标链接: /nodes
+- 描述: 新增美国洛杉矶高速节点,欢迎体验!
+- 有效期:
+  - 开始: 2024-01-20 00:00
+  - 结束: 2024-01-27 23:59
+- 状态: 启用
+
+## 广告显示规则
+
+### 显示条件
+广告需同时满足:
+1. 状态为"启用"
+2. 当前时间在有效期内
+3. 对应页面支持该类型
+
+### 显示位置
+- **Banner**: 页面顶部或底部
+- **Popup**: 页面加载时弹出
+- **Sidebar**: 页面右侧固定
+- **Notice**: 页面顶部滚动条
+
+### 显示频率
+- Popup类型:每个用户每天只显示一次
+- 其他类型:持续显示
+
+## 重要提示
+
+1. **有效期**: 过期广告自动不显示,无需手动关闭
+2. **图片外链**: 图片使用CDN外链,确保加载速度
+3. **链接测试**: 创建前测试目标链接是否正确
+4. **尺寸规范**: 不同类型广告建议不同图片尺寸
+5. **内容合规**: 广告内容需符合法律法规
+6. **提前创建**: 可以提前创建定时广告
+7. **Popup频率**: 弹窗广告不要过于频繁
+8. **移动适配**: 确保图片在移动端正常显示
+
+</div>