部署到线上
官方文档上已经列举了多个部署方案和教程 vitepress 部署
当前这个站点使用了两种部署方式:
- Gitee Pages服务
- 云服务器部署
部署前准备
执行build指令,将站点进行打包:
sh
$ npm run docs:build
sh
$ pnpm docs:build
sh
$ yarn docs:build
打包后在.vitepress
目录下生成的dist
目录内的文件,就是部署到线上的文件。
开通使用Gitee Pages服务部署
前提条件
DANGER
在gitee pages服务上部署,由于域名上会多出一个项目名称,如:https://wangcaiyuan_admin.gitee.io/notebooks
所以在打包之前,需要修改一下config
文件,添加base: "/notebooks/"
,否则访问会出现样式错乱和路由404问题
json
export default defineConfig({
base: "/notebooks/",
...
})
- 在gitee上创建一个仓库,必须是开源的,否则无法开通git pages服务
- 将整个vitepress项目推送到仓库 或 只推送打包后的dist目录下的文件也可以,看个人选择,主要是dist内的文件必须推送
TIP
如果是将整个项目推送到仓库的话,在项目根目录的.gitignore
内的dist/
需要去掉,否则dist/
目录会被忽略
- 开通gitee pages服务
TIP
如果是将整个项目推送到仓库的话,部署目录填 .vitepress/dist
,如果只上传了dist内的文件,填 ./
- 开通后点击启动,启动完成后会生成一个链接,就可以访问了。
TIP
部署成功后,以后每次修改内容,都需要执行以下步骤:
- 打包
- 推送代码到仓库
- 点击git pages服务里的更新