外观
CCB-Team.github.io
本站自身的源码仓库:基于 VitePress 的静态站点,通过 GitHub Actions 构建并发布到 GitHub Pages。
| 项 | 值 |
|---|---|
| 语言 / 框架 | JavaScript · VitePress 1.x(Vue 3 + Vite) |
| 部署 | GitHub Actions → GitHub Pages(deploy.yml) |
| 站点地址 | https://ccb-team.github.io/ |
| 仓库 | https://github.com/CCB-Team/CCB-Team.github.io |
目录结构
CCB-Team.github.io/
├── .github/workflows/deploy.yml # 构建 + 部署到 Pages
├── .vitepress/config.mjs # 站点配置:nav / sidebar / 主题文案
├── docs/
│ ├── index.md # 首页(hero + 方向卡片)
│ ├── projects/ # 项目介绍(本目录)
│ │ ├── index.md # 总览(含自动同步的仓库清单)
│ │ └── *.md # 各项目详情页
│ └── security/ # 安全 QA 测试记录
├── scripts/sync-projects.mjs # 从 GitHub 同步公开仓库清单
└── package.json本地开发
bash
npm ci
npm run dev # 本地预览(默认 http://localhost:5173)
npm run build # 产出静态文件到 .vitepress/dist
npm run preview # 预览构建产物
npm run sync # 重新生成「项目总览」里的公开仓库清单npm run sync 依赖已登录的 gh CLI(或环境变量 GITHUB_TOKEN), 读取 CCB-TEAM 下的公开仓库,重写 docs/projects/index.md 中 BEGIN:PROJECTS-TABLE 与 END:PROJECTS-TABLE 之间的表格,并提示哪些公开仓库还没有专属介绍页。 该脚本只在本地运行,不参与 CI 构建。
部署
推送到 main 分支即触发 .github/workflows/deploy.yml:
actions/checkout→actions/setup-node(Node 20,缓存 npm)npm ci→npm run buildactions/configure-pages→upload-pages-artifact(上传.vitepress/dist)actions/deploy-pages发布到github-pages环境
也可以在仓库的 Actions 页手动触发(workflow_dispatch)。
新增项目介绍页
- 在
docs/projects/下新建你的项目.md; - 在
.vitepress/config.mjs的themeConfig.sidebar['/projects/']对应分组里加一条{ text, link }; - 在
scripts/sync-projects.mjs的PAGE映射里补上仓库名 → 页面路径; - 运行
npm run sync刷新总览表格。
静态资源与样式
站点使用 VitePress 默认主题,未引入自定义主题或第三方 UI 依赖:Markdown + 内置容器(::: tip / ::: warning) 即可满足文档需求,构建产物纯静态、无运行时后端依赖。