Skip to content

Commit c72f561

Browse files
authored
Merge pull request #126 from WHUDAYS/feat/quq
添加头像注册说明
2 parents 9dad208 + cee702b commit c72f561

3 files changed

Lines changed: 276 additions & 249 deletions

File tree

AGENTS.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,27 @@
3030
| 任务 | 参考现有文件 |
3131
| --- | --- |
3232
| 加活动页 | `docs/activity/2024/winter-festival.md` |
33-
| 加成员卡 | `docs/group/vocaloid-utau-fans/index.md` |
33+
| 加成员卡 | `docs/activity/2025/welcome-party/credits.md` |
3434
| 加留声箱 | `docs/message-box/quq/words.md` |
3535
| 加部门/小群 | `docs/department/``docs/group/` 下任一 |
3636

37-
## 自定义组件
37+
## 针对框架的修改与二开
38+
39+
### 1. 自定义组件
3840

3941
`docs/.vitepress/theme/` 注册了两个全局组件,**必须用 `<ClientOnly>` 包裹**(否则 SSR/hydration 报错):
4042

41-
- `ChatMessage`:对话气泡。props `avatar` / `nickname` / `message`(支持 HTML)/ `position`。例:`docs/about/introduction.md`
42-
- `MemberCard`:成员卡。props `name` / `avatar` / `description` / `link` / `:badges` / `:socials`。例:`docs/group/vocaloid-utau-fans/index.md`
43+
- `ChatMessage`:对话气泡。仅 `docs/about/introduction.md` 中使用。props `avatar` / `nickname` / `message`(支持 HTML)/ `position`。例:
44+
- `MemberCard`:成员卡。仅在 `docs/group/vocaloid-utau-fans` 中使用。props `name` / `avatar` / `description` / `link` / `:badges` / `:socials`
45+
46+
### 2. gitChangelog 插件
47+
48+
为插件添加了 patch(`patches/@nolebase__vitepress-plugin-git-changelog@2.17.1.patch`) 以显示贡献者名称
4349

4450
用法细节见站点[贡献指南](https://whudays.org/maintainer/contributing)
51+
52+
### 3. 人员数据与贡献者映射
53+
54+
统一参考和修改 `docs/.vitepress/data/people.js`
55+
- **头像复用**:若某一成员的头像已存在,请直接复用,**不要新建条目**。暂无头像可缺省,会自动回退到占位图。
56+
- **贡献者别名映射**`people.js` 同时作为 `gitChangelog` 的作者数据源。如果成员是仓库提交者(有 GitHub),需在其数据对象中补充 `github` 字段,并根据 Git 历史配置 `mapByNameAliases``mapByEmailAliases`,插件才能将不同机器上的 commit 正确归拢到同一作者卡片下。

0 commit comments

Comments
 (0)