Documentation

Learn how to deploy to GitHub Pages with proper base path configuration for your framework.

The Base Path Problem

When deploying to username.github.io/repo-name, your app is served from a subdirectory. Without configuring the base path, assets will fail to load.

[-] Without base path: assets load from /assets/ (404 errors)

[+] With base path: assets load from /repo-name/assets/ (works)

Framework Configuration

Set the base path in your framework configuration file:

Quick Checklist

[*] Repository is public - Required for free GitHub Pages

[*] Base path configured - Set to /repo-name/ in your config

[*] Static export enabled - Required for frameworks like Next.js

[*] GitHub Actions workflow - File in .github/workflows/

Copied to clipboard!