知识库更新流程
知识库以静态服务的形式部署在服务器上,最新的版本保存在 github 仓库中,当需要更新知识库时,请遵循以下步骤
1. 从 github 获取最新版本的知识库
需要环境:
- git
- 代理工具(如果 git 连不上网的)
如果是第一次获取
shell
# 从 github 获取知识库项目
git clone https://github.com/SEUCXCS/cxcsknowbase.git
# 从 github 获取知识库项目
git clone https://github.com/SEUCXCS/cxcsknowbase.git
如果已经获取过一次
shell
# 进入项目目录
cd xxxx/cxcsknowbase
# 从github更新项目内容
git pull
# 进入项目目录
cd xxxx/cxcsknowbase
# 从github更新项目内容
git pull
2. 下载需要的资源
需要环境:
- node(v18以上)
- npm
shell
# 安装需要的npm包
npm i
# 安装需要的npm包
npm i
3. 打包前预览
打包前,需要使用写作模式看一看更新内容,看看是否有如下问题:
- 图片无法显示
- 包含一些不该出现的草稿
- 格式是否有缺漏
shell
# 启动写作模式
npm run docs:dev
# 出现如下输出则为启动成功,可在浏览器http://localhost:5173/查看
# vitepress v1.0.0-rc.13
#
# ➜ Local: http://localhost:5173/
# ➜ Network: use --host to expose
# ➜ press h to show help
# 启动写作模式
npm run docs:dev
# 出现如下输出则为启动成功,可在浏览器http://localhost:5173/查看
# vitepress v1.0.0-rc.13
#
# ➜ Local: http://localhost:5173/
# ➜ Network: use --host to expose
# ➜ press h to show help
如果有问题,可以反馈给提交者。
4. 打包
如果预览没问题的话,就可以打包了,有2种打包方式
打包耗时在1min以内,请耐心等待
bash(推荐)
使用bash在工作目录下使用./build.sh
运行打包脚本,若无报错即为打包成功
npm run
shell
npm run docs:build
npm run docs:build
然后./assets/
里的所有文件(大概2~3图片)复制到./.vitepress/dist/
下即可
5. 打包后预览
打包后,需要在在看一眼预览,保证上线无误,你需要注意:
- 所有图片是否显示正确
- 是否有404的页面
- 是否有报错
如果一切就绪的话,就可以部署了
6. 登陆服务器并部署
使用xshell登陆服务器(IP地址,用户名和密码由办公室管理员保管)
删除服务器上/www/cxcs/cxcsknowbase/.vitepress/
内的dist
文件夹,然后将本地工作目录的dist
文件夹(在./.vitepress/dist
)上传到服务器对于位置
查看网站是否正常工作,请使用Ctrl+shift+R
强制刷新页面来检查,以排除缓存带来的影响。