DOCUMENTATION // GUET 2026
《桂电封神榜》档案收录与配置文档
本项目支持通过 编写 Markdown 文件 或 在线生成器 自动化构建静态页面。本文档将详细教导你如何编写个人档案、配置元数据以及通过 GitHub Pull Request 进行提交或下架。
一、架构与工作流原理
本项目采用现代静态网页生成(SSG)技术,架构流程如下:
用户编写 Markdown (content/characters/*.md)
➔ 提交 GitHub Pull Request
➔ 合并至 main 分支
➔ GitHub Actions / Cloudflare Pages 自动构建
➔ 秒级自动更新并部署上线!
二、人物 Markdown 规范与配置字段
每个人物档案是一个独立的 .md 文件,存放在仓库的 content/characters/ 目录下。文件头部需包含 YAML Frontmatter 元数据:
---
id: xiaoming # [必填] 英文唯一标识,将作为 URL (例如 /characters/xiaoming.html)
name: 小明 # [必填] 人物姓名或称号
code: GUET-2026-XM01 # [可选] 战术档案编号
title: 毛衣编织战术特派员 # [必填] 头衔 / 称号
grade: 2026级 # [必填] 年级
category: 桂电26级名人 # [可选] 归类
department: 计算机与网络安全学院 # [必填] 所属学院或系所
status: ACTIVE # [可选] 状态: ACTIVE / INACTIVE / UNKNOWN
statusText: 编织中 / 在线 # [可选] 状态中文描述
clearance: LEVEL-3 # [可选] 密级: LEVEL-1 / LEVEL-2 / LEVEL-3 / TOP-SECRET
dangerLevel: SAFE # [可选] 危险评定: SAFE / CAUTION / HAZARD
avatar: /assets/images/avatars/xiaoming.svg # [可选] 头像路径
tags: # [必填] 核心标签列表 (首页可根据标签筛选)
- 爱织毛衣
- 讨厌gay
- 前女友是男生
quote: "毛衣虽暖,难御男娘之寒。" # [可选] 经典人物金句
summary: "桂电26级知名传奇人物..." # [必填] 首页展示的一句话摘要
stats: # [可选] 战术能力评分 (0-100)
knitting: 99
antiTrap: 98
defense: 86
coding: 78
sanity: 92
updatedAt: "2026-08-25" # [可选] 更新日期
---
## 个人概览 (OPERATOR OVERVIEW)
此处书写详细的人物生平、校园轶事或战绩。
## 核心特质分析
- **【特质名称】**:特质的来源与具体表现。
## 档案日志
> **【记录编号:GUI-2026-LOG-01】**
> 记录一件经典的校园轶事。
字段说明表 (Field Specification)
| 字段 (Key) | 类型 | 必填 | 说明 |
|---|---|---|---|
id |
String | 是 | 英文小写字母与数字、下划线,作为文件名与路由 (如 xiaoming)。 |
name |
String | 是 | 人物真实姓名或熟知的花名。 |
tags |
Array | 是 | 人物专属特征标签(如 爱织毛衣, 讨厌gay 等)。 |
summary |
String | 是 | 首页卡片展示的简短概述。 |
stats |
Object | 否 | 五维战术评分(0~100分)。 |
quote |
String | 否 | 人物标志性名言或口头禅。 |
三、如何提交新的档案 (贡献流程)
方法 A:使用网页在线生成器(推荐,零门槛)
- 点击导航栏的 【02 在线生成器】。
- 在左侧表单填写人物信息、标签及五维评分,右侧可实时预览 Endfield 风格卡片。
- 点击 “⚡ 一键在 GitHub 提交 PR / Issue” 或 “下载 .md 文件”。
- 提交后等待管理员审核合并,合并后数秒内即可在网站上看到新的人物档案!
方法 B:通过 Git 命令行或 GitHub 网页直接提交 PR
- 访问 GitHub 仓库:https://github.com/zxymiku/GUI2026 并点击右上角的 Fork。
- 在
content/characters/目录下新建一个以人物 id 命名的 Markdown 文件(例如content/characters/xiaohong.md)。 - 参考
content/characters/_template.md填写人物信息并保存。 - 提交 commit 并向
zxymiku/GUI2026的main分支发起 Pull Request。
四、本地开发与构建预览
如果你想在本地计算机上运行并调试本站:
# 1. 克隆你的仓库
git clone https://github.com/zxymiku/GUI2026.git
cd GUI2026
# 2. 安装依赖
npm install
# 3. 运行本地开发预览
npm run dev
# 4. 执行静态编译生成 dist 目录
npm run build
五、免责声明、隐私保护与下架申请
【重要守则】
1. 《桂电封神榜》为校园趣味文化记录项目,严禁任何恶意侮辱、造谣、人身攻击、泄露家庭住址/手机号/身份证等敏感隐私信息的行为。
2. 若被收录同学本人不希望被展示在榜单中,或认为内容失实,无须任何前置条件,本人有权随时要求无条件删除。
如何申请删除/下架条目?
- 方式 1(极速 PR):直接提交 PR 删除
content/characters/[你的id].md文件,管理员合并后网站即刻下架。 - 方式 2(提交 Issue):在 GitHub Issues 提交删除请求,注明对应人物姓名与条目 ID,管理员将在 24 小时内核实并删除。
- 深度清理 Commit 记录:若当事人需要彻底擦除 Git commit 历史记录,请在 PR 或 Issue 中注明,仓库管理员将通过
git filter-repo彻底擦除历史记录及 GitHub 缓存。