Skip to content

GitHub Actions script to deploy to GitHub Pages


Uses JamesIves/github-pages-deploy-action GitHub Action to deploy a site to the gh-pages branch of the same GitHub repository, which automatically makes the website available at (if your project and repository has name my-vue-webapp).

  • Create a branch in the repository called gh-pages
  • Go to the "Settings" section of your repository
  • Under "Code and automation" in the sidebar, click Pages.
  • Under "Build and deployment" under the "Source", select "Deploy from a branch".
  • Under "Build and deployment" under the "Branch" heading, use the branch drop-down menu and select the branch you want - gh-pages.

More details:

Setting base in Vite config

If you don't have a custom domain, you need to put the name of your repository as base in vite.config.ts so that the site can be accessed from the above link:

export default defineConfig({

If you have a custom domain (like, this parameter is not needed.