📝 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,131 @@
+<div v-pre>
+
+# 公告管理
+
+创建和管理系统公告,支持显示控制、置顶和弹窗功能。
+
+## 表格列说明
+
+### 显示 (Show)
+开关按钮,控制公告是否在前台显示。
+
+### 置顶 (Pinned)
+开关按钮,控制公告是否置顶显示。
+
+### 弹窗 (Popup)
+开关按钮,控制用户访问时是否弹窗显示公告。
+
+### 标题 (Title)
+公告标题。
+
+### 内容 (Content)
+公告正文内容(支持Markdown)。
+
+### 更新时间 (Updated At)
+最后更新时间。
+
+## 表格操作
+
+### 编辑
+打开侧边抽屉表单修改公告信息。
+
+### 删除
+删除公告(需确认),不可恢复。
+
+### 批量删除
+选中多个公告后批量删除。
+
+## 公告表单
+
+### 标题 (必填)
+公告的标题文字。
+
+### 内容 (必填)
+公告正文内容,支持Markdown格式:
+- 标题: # ## ###
+- 粗体: **文字**
+- 斜体: *文字*
+- 列表: - 项目
+- 链接: [文字](url)
+- 代码: `代码`
+
+## 筛选功能
+
+### 启用筛选
+- 显示: 查看已显示的公告
+- 隐藏: 查看已隐藏的公告
+
+### 关键词搜索
+输入标题或内容搜索公告。
+
+## 使用场景
+
+### 场景一: 创建重要通知
+
+**表单配置**:
+- 标题: 系统维护通知
+- 内容:
+  ```
+  # 系统维护通知
+
+  本系统将于 **2024年1月1日 02:00-04:00** 进行维护升级。
+
+  ## 影响范围
+  - 网站暂时无法访问
+  - 服务不受影响
+
+  感谢您的理解与支持!
+  ```
+- 显示: 开启
+- 置顶: 开启
+- 弹窗: 开启
+
+### 场景二: 创建活动公告
+
+**表单配置**:
+- 标题: 双11优惠活动
+- 内容:
+  ```
+  ## 🎉 双11优惠活动
+
+  - 全场套餐 **8折** 优惠
+  - 年付套餐额外赠送 **30天**
+  - 活动时间: 11.11-11.13
+
+  [立即购买](/subscribe)
+  ```
+- 显示: 开启
+- 置顶: 开启
+- 弹窗: 否
+
+### 场景三: 创建使用说明
+
+**表单配置**:
+- 标题: 新手使用指南
+- 内容:
+  ```
+  # 新手使用指南
+
+  ## 1. 购买套餐
+  进入 [订阅页面](/subscribe) 选择合适的套餐
+
+  ## 2. 下载客户端
+  前往 [文档中心](/docs) 下载对应平台客户端
+
+  ## 3. 导入配置
+  复制订阅链接到客户端即可使用
+  ```
+- 显示: 开启
+- 置顶: 否
+- 弹窗: 否
+
+## 重要提示
+
+1. **Markdown支持**: 内容支持Markdown格式,可排版精美公告
+2. **弹窗功能**: 开启后用户每次访问都会弹窗提示
+3. **置顶显示**: 置顶公告会在列表最上方
+4. **显示控制**: 可先创建后再开启显示
+5. **批量删除**: 删除操作不可恢复,谨慎操作
+6. **更新时间**: 每次编辑都会更新时间戳
+
+</div>