贡献指南
已经配置好自动根据docs目录下的文件结构生成侧边栏,贡献者只需要在docs目录下创建或编辑Markdown文件即可。
注意:文件夹以及文件需加上前缀数字用于侧边栏排序,在生成的侧边栏中会自动去除前缀数字。
目前整个目录结构为雏形,可自由更改目录结构等。
本地预览
可以在push或提交PR前在本地通过以下方式部署和预览:
- 环境准备
确保已经安装了Git和Node.js(版本18及以上,推荐安装LTS长期支持版)。
可以通过运行 node -v 和 npm -v 来检查是否安装成功。
- 获取项目代码
bash
git clone https://github.com/NJUIS-Students/NJUIS-Students.github.io.git
cd NJUIS-Students.github.io- 安装项目依赖
在项目根目录下运行:
bash
npm install如果安装过程中出现网络错误,尝试切换 npm 镜像源或使用科学上网工具。
bash
# 临时使用淘宝镜像源
npm install --registry=https://registry.npmmirror.com- 启动本地开发服务器
在项目根目录下运行:
bash
npm run docs:dev或者
bash
npx vitepress dev docs此时开发服务应该会运行在 http://localhost:5173 上。在浏览器中访问该地址以查看新站点的运行情况吧!