docs: 更新文档内容及结构调整

- 修复文档中的格式问题和错误
- 新增功能文档:数据迁移和管理后台
- 调整文档目录结构,将管理后台移至功能分类
- 更新API文档中的字段说明和响应示例
- 优化后端配置文档,移除冗余内容
This commit is contained in:
anghunk
2026-01-20 15:32:51 +08:00
parent 9d3d4f79a9
commit 4a4349e0b9
10 changed files with 216 additions and 299 deletions

View File

@@ -0,0 +1,85 @@
# 管理后台
管理后台用于审核评论、删除评论和管理评论设置。
## 设置
### 头像服务前缀
常用的 Gravatar 镜像服务:
| 服务 | 前缀地址 |
| --------------- | -------------------------------- |
| Gravatar 官方 | `https://gravatar.com/avatar` |
| Cravatar (国内) | `https://cravatar.cn/avatar` |
| 自定义镜像 | `https://your-mirror.com/avatar` |
### 显示博主标签
开启是否显示博主标签,配置博主邮箱和标签文字,即可在评论中显示博主标签;关闭为不显示。
### 邮箱提醒服务
目前接入了 QQ 邮箱提醒,后续会添加其他邮箱服务。
1. QQ 邮箱
- 登录 QQ 邮箱,进入 `设置 > 账户`
- 开启 `POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV 服务`,并获取授权码
- 在管理后台设置中配置 QQ 邮箱账号和授权码
## 使用官方管理后台
使用官方提供的管理后台最新版本https://cwd-comments.zishu.me。
登陆时填入你的 api 地址、账号和密码。
## 自部署
```bash
cd cwd-comments-admin
# 安装依赖
npm install
# 开发环境启动(默认端口见 vite.config.ts一般为 1226
npm run dev
# 生产环境构建
npm run build
# 本地预览生产构建结果
npm run preview
```
`cwd-comments-admin/dist` 目录部署到任意静态站点托管服务(如 Cloudflare Pages、Vercel、Netlify 等),并确保浏览器可以访问到后端 API 地址。
- 管理后台admin基于 Vite + Vue 3 的单页应用,用于管理评论和系统配置。
- `cwd-comments-admin/`:管理后台源码
- 运行环境:浏览器
- 构建工具Vite + Vue 3
### 环境变量与多环境配置
评论组件本身不依赖打包时的环境变量,只需要在运行时传入 `apiBaseUrl` 即可。
管理后台使用 Vite 环境变量进行多环境配置,推荐按以下方式区分开发 / 测试 / 生产环境:
`cwd-comments-admin` 目录下创建对应的环境文件:
```bash
# 开发环境
cp .env.example .env
```
每个环境文件中可配置以下变量:
| 变量名 | 说明 | 示例 |
| --------------------- | ----------------------------------------------- | ----------------------------------- |
| `VITE_API_BASE_URL` | 后端 API 地址Cloudflare Worker 域名或自定义) | `https://cwd-comments-api.test.com` |
| `VITE_ADMIN_NAME` | 登录页默认管理员账号占位值 | `admin@example.com` |
| `VITE_ADMIN_PASSWORD` | 登录页默认密码占位值 | `123456` |
说明:
- `VITE_API_BASE_URL` 会作为管理后台的默认 API 地址,实际请求地址可以在登录页修改,并持久化到 `localStorage`
- `VITE_ADMIN_NAME``VITE_ADMIN_PASSWORD` 仅用于自动填充登录表单,真正的认证信息以后端环境变量 `ADMIN_NAME``ADMIN_PASSWORD` 为准。

View File

@@ -0,0 +1,11 @@
# 数据迁移
目前支持从 Twikoo, Artalk 评论系统迁移数据。
其他评论框架逐步支持,欢迎提交反馈,可以将你想要迁移进来的框架以及相关结构提交到评论区,我会尽快添加支持。
**使用方法:**
`后台管理 > 数据导入`,选择你要导入框架类型,然后选择本地文件进行导入。
迁移程序会自动判断是否包含前缀(因部分框架默认不输出前缀),然后可以自定义前缀。