APERTURE LAB / DOCUMENTATION

官网开发文档

修改内容、验证效果,再将完整交付包发送给负责人。所有页面都是静态文件,无需部署账号即可本地开发。

01 / 开始开发

获取负责人提供的源码包并解压。使用 Node.js 22.13 或更新版本,在项目目录依次运行:

npm ci
npm run build
npm run dev

打开 http://127.0.0.1:8765。修改模板或数据后重新运行构建,再刷新浏览器。不要直接双击 HTML 文件。

02 / 文件与模块

src/pages.json
二级页面路由与标题。
src/pages/*.html
项目、成员、资料、关于、协作和联系页内容。
src/page.template.html
二级页面公共布局与面包屑。
src/partials/*.html
全站共享导航与页脚。
src/index.template.html
官网首页结构与文案。
src/docs.template.html
当前文档页面。
content/projects.json
项目目录及项目链接。
content/members.json
成员资料与无名展示位。
site.config.json
站名、URL、联系人及二维码有效期。
public/assets/portal.css
内容首页与文档页布局。
public/assets/styles.css
基础样式、品牌图形与成员卡。
scripts/build.cjs
将模板和数据生成静态 HTML。
public/
可发布的静态文件。

不要只修改生成后的 public/index.html 或 public/docs/index.html,否则会在下一次构建时被覆盖。

03 / 项目与资料维护

项目数据包括唯一 id、title、summary、direction、status、tags 和 links。方向为 software / hardware / systems;状态为 developing / maintaining / archived。链接由 label 与 url 组成,支持本站路径、锚点和 HTTPS 地址。

只添加有事实依据的项目与状态,不把计划当作已完成作品。项目目录当前仅收录确实存在的实验室官网项目。搜索按标题、简介和标签匹配,并可结合方向筛选。

资料下载文件位于 public/downloads/,更新后核对首页的下载链接。电话号码和二维码有效期统一在配置中维护;旧二维码过期后应更换真实新码,不能直接延长日期。

04 / 成员墙维护

{ "placeholderCount": 6, "members": [] }

当前仅展示六个无名空白位,不代表成员人数。添加真实成员后,空白位自动退出,搜索和方向筛选自动启用。

成员必填 id、name、directions。id 为唯一小写字母、数字及短横线;name 为 1–40 字符;directions 使用与项目相同的方向枚举。可选 role、bio、avatar、url。头像使用 /assets/members/文件名.webp 或 PNG;个人主页只允许 HTTPS。没有头像时使用姓名首字。

公开前确认成员同意,只展示本人选择公开的资料,不从申请表自动录入学号、电话或其他私人信息。没有真实资料时继续保留无名位即可。

05 / 检查与预览

npm run build
npm run check
npm test

检查桌面、手机和平板布局,确认没有横向溢出。验证项目搜索、方向筛选、无结果提示、成员墙、文档目录和模板下载。导航、拨号和复制号码也应正常。

Logo 与 favicon 保持当前路径和透明背景。动画支持减少动态效果;无 JavaScript 时仍能阅读项目、成员卡、文档与联系方式。资源总量目标小于 1 MB。

06 / 打包与提交

Windows 下执行:

npm run package

生成的完整 ZIP 包含可编辑源码、静态网站包、开发文档、交付说明和 SHA-256 校验清单。源码不包含 node_modules、凭据、旧备份或其他社团文件。

  1. 完成修改并通过检查。
  2. 附上修改说明、测试结果及已知问题。
  3. 将完整交付 ZIP 发送给负责人。
  4. 由负责人审阅并决定是否发布;保留上一份包以便回退。

官网没有上传 ZIP 或自动部署入口,开发者不需要把 Cloudflare Token 写入任何文件。

下载提交清单 ↓ · 下载项目提案模板 ↓