bit-guide：北理生活指南

项目简介

本项目是一个基于 MkDocs 构建的静态网页项目，旨在为北京理工大学新生（及新大二学生）提供全面的校园生活指南。内容由北理学长学姐共同编写，涵盖校园生活、活动社团、学习竞赛等方方面面，助力新生快速适应大学生活。

项目结构

bit-guide/

├── .github/workflows/ # GitHub Actions 工作流配置（用于自动化部署）

├── docs/ # 网页内容文件（包含各类指南文档，支持 LaTeX 语法）

└── mkdocs.yml # MkDocs 配置文件（定义网站导航、主题及功能设置）  

网页内容亮点

• 核心板块：
• 校园生活：学校介绍、校区设施（如良乡校区）、食堂美食、宿舍环境等
• 活动社团：校园活动、学生组织、社团介绍
• 学习竞赛：奖项评选标准、各类学科竞赛信息
• 附录：入学准备、周边设施、常见问题等实用内容
• 特色信息：
• 解答新生高频疑问（如无强制校园跑、生活费参考标准等）
• 包含“北理黑话”等校园文化内容，帮助快速融入校园
• 支持公众贡献，持续完善指南内容

本地使用指南

1. 克隆仓库到本地： git clone https://github.com/yht0511/bit-guide.git cd bit-guide   2. 安装依赖（需先安装 Python）： pip install mkdocs mkdocs-material   3. 本地预览网页： mkdocs serve  

访问  http://127.0.0.1:8000  即可查看效果。

在线访问

静态网页在线地址：https://yht0511.github.io/bit-guide/

（目前处于开发阶段，后续会购置一个使用域名）

贡献方式

• 新增内容：在  docs  目录添加 Markdown 文档，如需展示在导航栏，可修改  mkdocs.yml  中的导航配置
• 完善功能：可编辑  .github/workflows  目录下的文件调整工作流，或更新  mkdocs.yml  扩展网站功能
• 提交说明：提交修改时请简要描述内容，便于追溯更新

致谢

感谢所有参与编写的北理学长学姐，本项目因“用爱发电”而不断完善！