开发教程
必备条件
基础知识
- Git 和 GitHub 的使用方法
- 推送
- 提交
- 同步
- 提交推送请求（Pull Request）
- Markdown 语法
- 基础开发知识
应用
- Git 或 GitHub Desktop
- 用于提交和推送更改
- 推荐新手使用 GitHub Desktop
- nodejs
- 提供 JavaScript 运行环境
- pnpm
- JavaScript 包管理器，安装依赖和运行脚本
- VS Code
- 推荐的代码编辑器，支持 Markdown 编辑和 Git 集成
VS Code 插件
💡 提示
非必需，但是装上可以大幅提高编写效率🚀
- markdownlint
- 用于检查 Markdown 文档的语法和风格问题
- Markdown All in One
- 提供一些快捷键和缩进辅助
- Prettier - Code formatter
- 将此扩展作为默认的格式化工具
编写规范
详见编写规范
克隆项目
在 GitHub 上 fork 本项目到你的账户下，然后使用 Git 或 GitHub Desktop 将项目克隆到本地
git clone https://github.com/Survive-HFUT/survive-hfut.github.io.git命令行操作
在 VS Code 中打开项目文件夹后，可以使用内置的终端（默认快捷键Ctrl+J）来执行以下命令：
安装依赖
用于安装项目所需的依赖包，确保文档能够正确构建和预览
pnpm install💡 提示
运行其他命令之前都需要先执行这个命令来安装依赖，之后如果有新的依赖需要安装也需要重新执行一次
运行即时预览
此命令会启动一个本地开发服务器，并在浏览器中打开文档预览界面。你可以在编辑 Markdown 文件时实时看到更改的效果
pnpm run docs:dev构建文档
此命令会将文档构建成静态文件，生成在docs/.vitepress/dist目录下
pnpm run docs:build💡 提示
不过通常情况下并不需要你手动这么做，因为此项目会在提交推送时自动使用 GitHub Actions 进行构建和部署
本地构建完成后可以在docs/.vitepress/dist目录下找到生成的静态文件，或者直接访问在命令行输出如下命令来查看效果
pnpm run docs:preview提交与推送
💡 提示
如果你打算添加共同作者（Co-Author）的话，建议使用 GitHub 所提供的邮箱地址进行更改，否则可能导致在生成页面底部的贡献者名单时无法正确抓取到 GitHub 上的头像和用户名
你也可以在仓库下的docs/.vitepress/helpers/contributors.ts文件中手动添加贡献者信息来解决这个问题
在完成文档编辑后，你需要将更改提交到 GitHub 仓库。你可以借助 GitHub Desktop 或者直接在 VS Code 的源代码管理界面进行提交和推送
推送到 GitHub 后，你可以在 GitHub 上发起一个 Pull Request来请求将你的更改合并到主分支
等待 PR 被审核和合并后，你的更改就会被部署到生产环境，其他人也可以看到你的贡献了！🎉
gforoosge