shumengya/cwd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: 添加评论组件多语言配置相关文档

Browse Source 
- 在前端配置指南中增加 `lang` 配置项说明及多语言优先级规则
- 在公开配置接口文档中添加 `adminLanguage` 和 `widgetLanguage` 字段
- 更新管理后台功能设置接口文档，包含语言配置字段及详细说明
This commit is contained in:
anghunk
2026-02-10 14:48:56 +08:00
parent ccd558090c
commit 231571091c
3 changed files with 81 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/api/public/config.md
View File

@@ -35,24 +35,28 @@ GET /api/config/comments
"enableCommentLike": true,
"enableArticleLike": true,
"enableImageLightbox": true,
"commentPlaceholder": "发表你的看法..."
"commentPlaceholder": "发表你的看法...",
"adminLanguage": "zh-CN",
"widgetLanguage": "auto"
}
```
字段说明：
| 字段名 | 类型 | 说明 |
| -------------------- | ------ | -------------------------------------------------------------------- |
| `adminEmail` | string | 博主邮箱地址，用于在前端展示"博主"标识，并触发管理员身份验证流程 |
| `adminBadge` | string | 博主标识文字，例如 `"博主"` |
| `avatarPrefix` | string | 头像地址前缀，如 Gravatar 或 Cravatar 需像地址 |
| `adminEnabled` | boolean | 是否启用博主标识相关展示（关闭时不显示徽标，但仍可作为管理员邮箱） |
| `allowedDomains` | Array\<string\> | 允许调用组件的域名列表，留空则不限制 |
| `requireReview` | boolean | 是否开启新评论先审核再显示（true 表示新评论默认为待审核） |
| `enableCommentLike` | boolean | 是否启用评论点赞功能（默认 true） |
| `enableArticleLike` | boolean | 是否启用文章点赞功能（默认 true） |
| `enableImageLightbox` | boolean | 是否启用评论图片灯箱预览功能（默认 false） |
| `commentPlaceholder` | string \| null | 评论输入框的占位符文本，留空则使用默认值 |
| 字段名 | 类型 | 说明 |
| -------------------- | ----------------- | -------------------------------------------------------------------- |
| `adminEmail` | string | 博主邮箱地址，用于在前端展示"博主"标识，并触发管理员身份验证流程 |
| `adminBadge` | string | 博主标识文字，例如 `"博主"` |
| `avatarPrefix` | string | 头像地址前缀，如 Gravatar 或 Cravatar 需像地址 |
| `adminEnabled` | boolean | 是否启用博主标识相关展示（关闭时不显示徽标，但仍可作为管理员邮箱） |
| `allowedDomains` | Array\<string\> | 允许调用组件的域名列表，留空则不限制 |
| `requireReview` | boolean | 是否开启新评论先审核再显示（true 表示新评论默认为待审核） |
| `enableCommentLike` | boolean | 是否启用评论点赞功能（默认 true） |
| `enableArticleLike` | boolean | 是否启用文章点赞功能（默认 true） |
| `enableImageLightbox`| boolean | 是否启用评论图片灯箱预览功能（默认 false） |
| `commentPlaceholder` | string \| null | 评论输入框的占位符文本，留空则使用默认值 |
| `adminLanguage` | string \| null | 管理后台界面语言代码，如 `zh-CN`、`en-US`，仅供后台使用 |
| `widgetLanguage` | string \| null | 评论前端组件默认语言代码，支持 `auto` 自动根据浏览器语言选择 |
**错误响应**