成员条目填写指南
成员列表 里的每张卡片,都对应 archive/members/entries/ 目录下的一个 Markdown 文件。一人一个文件,这个文件同时也是你的详情页。
最快的方式:找 bot
在群里找海上修机师 bot 更新自己的条目,bot 会帮你生成文件并提交 PR,管理员审核合并后就会上线,头像自动用你的 QQ 头像。
想自己动手,或者想写一篇更长的详细介绍,就按下面的步骤来。
自己提交:四步
- 打开 仓库 的
archive/members/entries/目录,点右上角 Add file → Create new file(没有写权限时 GitHub 会自动帮你 Fork)。 - 文件名填
你的id.md,例如张三.md。 - 把下面的模板粘贴进去,按自己的情况改。
- 点 Commit changes,再按提示创建 Pull Request,等管理员合并。
已经有条目、只想修改:找到自己的文件,点右上角的铅笔图标编辑,后面的步骤一样。
模板
---
name: 你的名字
bio: 一句话介绍自己
qq: 123456789
---
这里开始写详细介绍,只显示在你的详情页里。---
name: 你的名字
bio: 一句话介绍自己
qq: 123456789
---
这里开始写详细介绍,只显示在你的详情页里。上面用 --- 包起来的部分叫 frontmatter,字段名: 值 一行一个,冒号后面要有一个空格。
字段说明
| 字段 | 必填 | 填什么 | 示例 |
|---|---|---|---|
name | 是 | 卡片上显示的名字,昵称、ID 都可以 | name: zzq |
bio | 是 | 一行自我介绍,显示在卡片上,建议 20 字以内 | bio: 猫娘 |
qq | 否 | 你的 QQ 号,用来显示 QQ 头像 | qq: 123456789 |
avatar | 否 | 不想用 QQ 头像时,填一个 https:// 开头的图片地址,优先于 qq | avatar: https://example.com/me.png |
关于 QQ 号
qq 会原样公开在仓库和网页源码里,任何人都能看到。介意的话就不填,或者改用 avatar。
文件名(id)规则
- 只能用中文、小写字母、数字、
-和_,不能有大写、空格和其他符号。一般直接用名字,例如张三.md。 - 它决定详情页地址(
张三.md对应/archive/members/entries/张三),也是排序分组时用的名字。 - 定下来以后尽量不要改:改了以前分享出去的链接会失效,详情页下面的留言也会对不上(留言按 id 归档)。
详细介绍怎么写
--- 下面的正文支持完整的 Markdown,写多长都行。不知道写什么,可以参考这些方向:
- 哪一届加入的,在组织里做过什么
- 擅长的方向:硬件、系统、网络、写代码……
- 印象深刻的一次修机经历
- 想对后来者说的话
- 个人主页、博客、GitHub 等链接
示例:
---
name: 111
bio: 111
qq: 123456789
---
2023 年加入海上修机师,主要负责网站维护和资料整理。
## 擅长
- 笔记本拆机清灰
- 系统重装与数据迁移
## 想说的话
遇到不会修的机器别硬来,先拍照、再查资料、最后问前辈。
个人博客:<https://example.com>---
name: 111
bio: 111
qq: 123456789
---
2023 年加入海上修机师,主要负责网站维护和资料整理。
## 擅长
- 笔记本拆机清灰
- 系统重装与数据迁移
## 想说的话
遇到不会修的机器别硬来,先拍照、再查资料、最后问前辈。
个人博客:<https://example.com>常见问题
新加的人排在哪? 刚加进来、还没被排进分组的成员,会出现在列表最下面,等管理员排进分组后就会移过去,见下面的「排序与分组」。
提交后多久能看到? PR 合并后网站会自动重新部署,通常几分钟内生效。
PR 显示检查没通过? 打开检查详情,会列出具体是哪个文件、哪个字段有问题,常见的有:文件名带了大写或中文、漏了 name 或 bio、bio 写成了多行、qq 不是纯数字。改好再提交一次即可。
头像不显示,只显示首字母? 确认 qq 填对了,或者 avatar 是能直接打开的 https:// 图片地址。图片加载失败时也会显示首字母。
名字里有冒号、# 之类的符号? 整个值用英文双引号包起来,例如 name: "A:350"。
想删除自己的条目? 删掉自己的文件并提交 PR,或者直接找管理员。
排序与分组(管理员)
卡片的顺序和分组写在成员列表页 archive/members/index.md 里,不写在个人文件中。卡片堆之间可以随意插入标题或文字:
## 2023级
<MemberList ids="张三, 李四, 王五" />
## 2024级
这一届是第一次参加百团大战的学弟学妹。
<MemberList ids="赵六, 钱七" />
<MemberList rest title="其他成员" />## 2023级
<MemberList ids="张三, 李四, 王五" />
## 2024级
这一届是第一次参加百团大战的学弟学妹。
<MemberList ids="赵六, 钱七" />
<MemberList rest title="其他成员" />ids里写成员 id(文件名去掉.md),按想要的顺序排列,中英文逗号都行。- 每个
<MemberList ids="..." />是一堆卡片,电脑上一排四个,平板上一排三个,手机上一排两个。 <MemberList rest title="其他成员" />放没写进任何ids的成员(例如 bot 刚加的人),按名字排序;一个都没有时连标题一起隐藏。建议一直留在页面最下面,免得有人漏掉。ids里写了不存在的 id 时,网站构建会直接报错并指出是哪个 id,改成正确的文件名即可。
给维护者和 bot
- bot 生成的文件格式与上面的模板相同,文件名用成员的
id。同一成员再次更新时修改同一个文件,不要新建。 qq填发送者本人的 QQ 号。只改 frontmatter 时保留原有正文;更新详细介绍时整体替换正文。- PR 会自动跑「Validate Members」检查(文件名与 frontmatter 格式校验),构建检查由现有 Pages 工作流完成。
- 审核时确认
qq是本人的号码、本人同意公开,且介绍内容没有不当信息。合并即发布,删除文件即下线。