✨ InSUEP - 上海电力大学信息直通车 ✨

💫 信息共享，让电专不再电专 💫

📖 项目概述 • ✨ 特性 • 🚀 开始使用 • 📁 项目结构 • 🧪 开发指南 • 🤝 贡献指南 • 📝 许可协议 • 🙏 致谢

---

📖 项目概述

InSUEP（上海电力大学信息直通车）是一个由上海电力大学学生共同编写的信息平台，旨在为新老学生提供校园生活的方方面面的信息指南。该项目使用 VuePress 2.0 构建，提供了清晰直观的界面，整合了 SUEP-Book 的优质内容，力求打造最全面的上电校园攻略。

✨ 特性

• 🚀 基于 VuePress 2.0 构建，性能优异
• 📱 响应式设计，适配各种设备
• 🔍 内置搜索功能，快速找到所需信息
• 🎨 现代简洁的主题设计
• 📝 增强的 Markdown 支持
• 🌐 支持自动部署
• 📚 涵盖上电校园生活的方方面面

🚀 开始使用

🛠️ 环境要求

• Node.js (推荐 LTS 版本)
• Yarn 4.1.1 或更高版本

📥 安装与运行

1. 克隆仓库

   git clone https://github.com/emptydust/InSUEP.git
   cd InSUEP

2. 安装依赖

   yarn install

3. 启动开发服务器

   yarn dev

4. 构建生产版本

   yarn build

5. 部署

   yarn deploy

📁 项目结构

InSUEP/
├── docs/              # 文档源文件
│   ├── 入学之前/      # 入学前指南
│   ├── 入学指南/      # 入学相关信息
│   ├── 5分熟/         # 校园生活指南
│   ├── 老生入门/      # 高年级学生指南
│   └── .vuepress/    # VuePress 配置文件
├── public/           # 静态资源
├── package.json      # 项目依赖和脚本
└── vuepress.config.js # VuePress 配置

🧪 开发指南

🔧 技术栈

• VuePress 2.0: 文档框架
• Vue 3: 前端框架
• TypeScript: 类型安全
• SASS: 样式处理
• Yarn: 包管理

💻 开发环境设置

推荐使用 VSCode 进行开发，并安装以下扩展：

• Vue Language Features (Volar)
• ESLint
• Prettier

📋 环境要求

• Node.js >= 21
• Yarn >= 4.1.1
• Vue

🔌 已安装插件

• @vuepress/bundler-vite
• vuepress-plugin-md-enhance
• vuepress
• vuepress-theme-hope

🤝 贡献指南

我们非常欢迎各种形式的贡献！无论是新功能、内容更新、bug 修复还是文档改进。

🔄 贡献步骤

1. Fork 本仓库
2. 创建你的特性分支 (git checkout -b feature/amazing-feature)
3. 提交你的更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 开启一个 Pull Request

⚠️ 注意事项

• 请将 PR 提交到 debug 分支，而不是 main 分支
• 提交前请确保本地运行 yarn build 无错误
• 遵循项目的代码风格和提交规范

📋 待办事项

• 🎨 寻找更多志愿者完善界面美化
• 🖼️ 增加图标资源
• 📚 丰富网站内容
• 🏗️ 改进主页设计和功能

🙏 致谢

• 感谢所有提出意见的同学和帮助完善界面、文档的朋友
• 特别感谢 SUEP-Book 的创作者分享了宝贵的文档内容
• 项目灵感来源于 innenu

📞 联系我们

• 💬 QQ 交流群: 726427904 (上电算法竞赛交流群)
• 🐞 GitHub Issues: 如有问题或建议，请在 GitHub 仓库中提出 issue

📝 许可协议

本作品采用 知识共享署名-非商业性使用-禁止演绎 4.0 国际许可协议 进行许可。

---

_{用 ❤️ 打造 | Copyright © 2025 InSUEP}