基于 Astro 的 Starlight 模版构建的 HUAT 方程式赛车队文档站点。
Page was deployed @ Cloudflare Pages on behalf of @nekorectifier
- 🚀 高性能 - 基于 Astro 构建，支持零 JavaScript 静态生成
- 📱 PWA 支持 - 离线访问、可安装为应用
- 🌐 国际化 - 中英文双语支持
- 🎨 多主题 - 亮色/暗色主题，多色彩方案
- ♿ 可访问性 - 符合 WCAG AA 标准
- 📊 分析集成 - Umami Analytics 事件跟踪
- 🔍 全文搜索 - Pagefind 驱动的站内搜索
- Node.js 18+
- pnpm 8+
# 克隆仓库
git clone https://github.com/HUAT-FSAC/Guidance-Astro.git
cd Guidance-Astro
# 安装依赖
pnpm install
# 启动开发服务器
pnpm dev访问 http://localhost:4321 查看站点。
pnpm build
pnpm previewGuidance-Astro/
├── public/ # 静态资源
│ ├── favicon.png
│ ├── manifest.json # PWA 配置
│ ├── sw.js # Service Worker
│ └── offline.html # 离线页面
├── src/
│ ├── assets/ # 可优化的资源
│ │ └── docs/ # 文档图片
│ ├── components/ # Astro 组件
│ │ ├── home/ # 主页组件
│ │ └── docs/ # 文档组件
│ ├── content/ # 内容集合
│ │ ├── docs/ # MDX 文档
│ │ └── i18n/ # 国际化翻译
│ ├── data/ # 数据配置
│ ├── styles/ # 全局样式
│ └── utils/ # 工具函数
├── astro.config.mjs # Astro 配置
├── sidebar.mjs # 侧边栏配置
└── docs-meta/ # 项目文档（贡献指南、变更日志等）
特殊字符转义：内容中（特别是表格里）如果包含 < (小于号)，必须转义：
- ❌ 错误：
| <1A | - ✅ 正确：
| \<1A |或| `<1A` |
Aside 组件类型：Starlight 的 Aside 组件支持的类型：
- ✅ 正确：
note,tip,caution,danger - ❌ 错误：
warning（不支持）
文档图片请存放在 src/assets/docs/ 下对应的年份和模块文件夹中：
src/assets/docs/
├── 2025/
│ ├── 感知/
│ ├── 定位建图/
│ ├── 规控/
│ ├── 仿真测试/
│ ├── 电气/
│ ├── 机械/
│ └── 项管/
└── videos/
引用方式：
import { Image } from 'astro:assets'
import myImage from '../../assets/docs/2025/感知/lidar-setup.png'
<Image src={myImage} alt="激光雷达安装示意图" />- 删除
package-lock.json(避免与 pnpm 冲突) - 保留并提交
pnpm-lock.yaml pnpm-workspace.yaml中的构建配置严禁删除
项目已配置 ESLint 和 Prettier：
# 检查代码规范
pnpm lint
# 自动修复
pnpm lint:fix
# 格式化代码
pnpm format欢迎贡献！请查看 CONTRIBUTING.md 了解详情。
- Fork 本仓库
- 创建特性分支 (
git checkout -b feature/amazing-feature) - 提交更改 (
git commit -m 'feat: add amazing feature') - 推送到分支 (
git push origin feature/amazing-feature) - 创建 Pull Request
MIT License - 详见 LICENSE