# BUPT 生存指南

> 北京邮电大学生存指南，从沙河到本部，从入学到毕业的全程陪伴

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
[![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC_BY--SA_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-sa/4.0/)

## 项目简介

BUPT 生存指南是一个开源的北京邮电大学学生生活指南，旨在帮助新老同学更好地适应校园生活。本指南覆盖了沙河校区和本部校区的详细信息，包含住宿、餐饮、学习、交通、生活服务等方方面面的实用指南。

## 本地开发

### 环境要求

- Node.js 18+ 
- pnpm（推荐）或 npm

### 常用命令

| 命令 | 说明 |
| :--- | :--- |
| `pnpm install` | 安装依赖 |
| `pnpm dev` | 启动开发服务器 (`localhost:4321`) |
| `pnpm build` | 构建生产版本到 `./dist/` |
| `pnpm preview` | 预览构建结果 |
| `pnpm astro ...` | 运行 Astro CLI 命令 |

## 参与贡献

我们欢迎所有 BUPT 同学为这个项目贡献内容！

### 如何贡献

1. Fork 本仓库
2. 编辑文档
3. 提交更改 (`git commit -m 'Add something'`)
4. 推送到分支 (`git push origin main`)
5. 创建 Pull Request

详细的贡献指南请参考：[贡献指南](./src/content/docs/contributing.md)

## 内容来源

### 致谢

本指南的内容来源于多个项目和众多同学的无私贡献：

- **沙河校区部分**：主要来源于 [BUPTSE/welcome](https://github.com/BUPTSE/welcome) 开源项目
- **本部校区部分**：来源于同学们在腾讯在线文档中的集体创作

感谢所有贡献者的无私分享！完整的致谢名单请查看：[致谢页面](./src/content/docs/acknowledgments.md)

## 技术栈

- [Astro](https://astro.build/) - 静态站点生成器
- [Starlight](https://starlight.astro.build/) - 文档主题
- [Catppuccin](https://github.com/catppuccin/starlight) - 配色主题
- Markdown - 内容编写
- TypeScript - 类型安全

## 联系我们

如有任何问题或建议，欢迎向我们发送 Email：[contact@byrdocs.org](mailto:contact@byrdocs.org)。

## 开源协议

本项目采用 CC-BY-SA-4.0 协议，详情请参考 [LICENSE](LICENSE) 文件。

---

**Made with ❤️ by BUPT Students**

> 愿这份指南能成为你 BUPT 求学路上的好伙伴！