Rift Logo RiftJS

Deploying Rift to GitHub Pages

GitHub Pages is a free static hosting service for open source projects and documentation. It serves your static site directly from a GitHub repository branch.

Steps

  1. Build your Rift site: npm run build
  2. Push the contents of dist/ to a gh-pages branch (or docs/ folder for user/organization sites).
  3. In your repository settings, set GitHub Pages to use the gh-pages branch (or docs/ folder).
  4. Visit your site at https://<username>.github.io/<repo>/

Tips

  • Ensure 404.html is present at the root of dist/ for error handling.
  • Use a tool like gh-pages npm package for easy deployment.
SettingValue
Branch/foldergh-pages or docs/
Default domain*.github.io
Free HTTPS✅ Yes
Auto redeploysManual or via GitHub Actions