Skip to content

Repository files navigation

成理工程生存指南 & 飞跃手册

成都理工大学工程技术学院学生知识库,由贴吧吧务团队运营维护,同学们共建共享。

🔗 在线访问https://cdutetc-tieba.top/

📖 内容板块

生存指南

  • 入学指南:新生报到须知、推荐物品清单
  • 学业相关:考试备考、绩点、转专业与校内事务
  • 校园生活:宿舍、快递与校园风光
  • 校园地图:教学楼、校园设施与交互式地图
  • 周边探索:校内外餐饮与周边信息
  • 常见问题:FAQ 合集

飞跃手册

  • 出路思考:读研、就业与其他毕业选择的目的和成本
  • 考研:备考经验、院校选择、复试技巧
  • 留学:地区指南、语言考试与选校申请
  • 就业/实习:简历面试、行业分享、实习经历

技术文档

  • 项目架构、内容设计、开发文档、贡献指南等技术资料

🛠️ 技术栈

  • 框架VitePress 1.x(基于 Vite + Vue 3)
  • 托管:GitHub Pages
  • 包管理:pnpm
  • 代码质量:Prettier + markdownlint
  • CI/CD:GitHub Actions 自动构建部署

🚀 本地开发

环境要求

  • Node.js >= 18
  • pnpm >= 8

快速开始

# 克隆仓库
git clone https://github.com/cdutetc-tieba/CDUTETC-Guide.git
cd CDUTETC-Guide

# 安装依赖
pnpm install

# 启动开发服务器
pnpm docs:dev

# 构建生产版本
pnpm docs:build

# 预览构建结果
pnpm docs:preview

常用命令

命令 说明
pnpm docs:dev 启动开发服务器(热更新)
pnpm docs:build 构建生产版本
pnpm docs:preview 预览构建结果
pnpm format 格式化所有 Markdown 文件
pnpm format:check 检查格式是否一致
pnpm lint 检查 Markdown 规范
pnpm lint:fix 自动修复 Markdown 规范问题

📝 投稿指南

方式一:GitHub Pull Request(推荐)

  1. Fork 本仓库
  2. 在对应目录下创建新的 Markdown 文件
  3. 参考 docs/templates/ 中的模板编写内容
  4. 提交 Pull Request
  5. 等待审核合并后自动上线

方式二:邮件投稿

将内容以 Word 文档形式发送至邮箱,由维护者代为上架。

文件命名规范

  • 使用英文短横线命名(kebab-case)
  • 简短且有意义
  • 示例:postgraduate-experience.mddorm-life-guide.md

模板选择

  • 校园实用信息:docs/templates/survival-entry.md
  • 校园处境与观点文章:docs/templates/survival-perspective-entry.md
  • 考研、留学和就业经历:分别使用对应的 leap-*-entry.md

所有文章都包含标题和描述;具体筛选字段以所选模板为准:

---
title: 文章标题
order: 1
description: 文章解决的问题或样本背景
---

飞跃手册案例只接收本人投稿或获得明确授权的访谈。公开页面可以匿名,但经历来源需要由维护者确认。

📁 项目结构

CDUTETC-Guide/
├── .github/workflows/     # CI/CD 工作流
├── docs/
│   ├── .vitepress/        # VitePress 配置
│   │   ├── config.ts      # 主配置
│   │   ├── utils/sidebar.ts # 侧边栏自动生成
│   │   └── theme/         # 主题定制
│   ├── index.md           # 首页
│   ├── survival/          # 生存指南
│   ├── leap/              # 飞跃手册
│   ├── blog/              # 技术文档
│   ├── contribute.md      # 投稿指南
│   ├── templates/         # 投稿模板
│   └── public/            # 静态资源
├── package.json
├── .prettierrc.yaml
├── .markdownlint.yaml
└── .editorconfig

🎨 设计风格

采用工程构成主义 + 高可读性手册设计语言:

  • 暖灰米白纸面 #ebe8de、矿物红 #b9362a、近黑结构色 #151718
  • 首页以 HL-1 工程线稿、天体弧面和斜向结构线建立校园核工业辨识度
  • 正文页仅保留短红色标记、结构线和清晰的粗体无衬线标题
  • 亮色与暗色模式分别适配,并覆盖桌面、宽屏和移动端视觉回归测试

完整规范见 docs/blog/design-system.md


你的经验,就是下一盏路灯。

About

成都理工大学工程技术学院 生存指南 & 飞跃手册

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages