将Vue3项目部署到Github Page

背景

工作中使用 vue 开发项目,部署测试环境就是把构建好的 dist 包放到服务器的指定目录。如果想要自己倒腾一个小网站呢,又不想买服务器费钱费力,那免费的 Github Page 很值得推荐。

实现步骤

  1. 假定已经有一个 vue 项目,并且提交到了 github 仓库。
  2. 设置和部署,打开项目中的vite.config.ts,找到下面代码块,更改为对应的 github 仓库名称
ts 复制代码
export default defineConfig({
    base: '/sycamore-cottage/', // github仓库名称
    plugins: [],
})
  1. 创建 gh-pages 分支,并将打包的 dist 文件夹下的所有东西上传到gh-pages 分支 注意 ⚠️:一般情况下"/dist "文件夹会被写进本地 .gitignore"(规定哪些文件会被 git 忽略不进行版本控制),所以如果 gitignore 文件有有 dist,要先暂时移除掉。执行以下命令进行提交。
shell 复制代码
npm run build
git subtree push --prefix dist origin gh-pages
  1. 更改 github page 设置 打开 github 仓库的 setting 配置,选择 Pages 配置项,Source 项选择 Deploy from a branch,Branch 项选择 gh_pages 分支下的/(root)文件夹。

  2. 验证是否部署成功。 访问user.github.io/repo, user为github用户名,repo为github仓库名,例如本例的地址为AprilTong.github.io/sycamore-co...

方法二自动部署

在方法一部署好之后,感觉每次要更新,都需要手动将 dist 目录上传到 gh-pages 分支,比较麻烦。联想到公司项目是通过 gitlab-runner 配置提交到指定分支然后自动构建。然后进行搜索,果然有!

  1. 和上述一样,需要更改的vite.config.ts
  2. 进入仓库 settings 页面的 GitHub Pages 配置,选择部署来源为"GitHub Actions"
  3. 选择创建一个 workflow , 文件命名为 main.yml,查看我的项目配置
shell 复制代码
 # 推送到指定分支时运行
 push:
    branches: ['master']
  1. 修改代码提交到你配置的分支试试吧。在 actions 中就可以看到构建流程了。点击可查看报错等细节。

参考文章

相关推荐
FRing0327 分钟前
vue3干货总结2(vue3生命周期、父子通信、模版引用、provide和inject)
开发语言·前端·vue.js·vue3
锋行天下2 小时前
langgraph 全栈项目(三)
前端·人工智能·后端
锋行天下3 小时前
langgraph 全栈项目(二)
前端·人工智能·后端
锋行天下4 小时前
langgraph全栈项目(一)
前端·人工智能·后端
叼烟扛炮4 小时前
[LangChain] 学习笔记(15):为什么你的重试没用——429、抖动、fallback 与熔断
java·服务器·前端
小码哥0685 小时前
智慧物业系统源码定制:公告发布范围与住户阅读记录设计
前端·javascript·vue.js·物业管理·物业系统·物业软件
杨凯凡7 小时前
IT日报|2026-11-20:欧盟 AI 网络攻击、Valkey 9.2、GitHub 企业迁移
人工智能·github
泯泷7 小时前
Cloudflare 出手抢 Astro:前端框架之战,底层逻辑变了
前端·javascript·前端框架
TunerT_TQ8 小时前
Terraform OCI Provider 2026:工具链的骨架清晰可见,CRUD 的肌肉必须由你亲自验证
github