GitHub Pages Redirect

A simple template for redirecting your GitHub Pages site (username.github.io) to your custom domain.

Features

• ✨ Lightweight and fast redirect solution
• 🎯 Easy to set up in minutes
• 📱 Works on all devices and browsers
• 🔗 Preserves URL paths during redirect

Quick Start

1. Fork or use this template to create a new repository named username.github.io
2. Update the domain in the HTML file:
   • Replace example.com with your actual domain
3. Enable GitHub Pages in your repository settings
4. Visit https://username.github.io to test the redirect

How It Works

This template uses a simple HTML meta refresh to redirect visitors from your GitHub Pages URL to your custom domain. The redirect happens automatically when users visit your username.github.io page.

Installation

Option 1: Using as a Template

1. Click "Use this template" on the GitHub repository page
2. Name your repository username.github.io (replace username with your GitHub username)
3. Customize the domain in index.html

Option 2: Manual Setup

1. Create a new repository named username.github.io
2. Copy the contents of this template to your repository
3. Update the redirect URL in index.html
4. Push to GitHub

Configuration

Edit index.html and change this line:

<meta http-equiv="refresh" content="0;url=https://example.com" />
<link rel="canonical" href="https://example.com" />

Replace https://example.com with your actual domain.

Troubleshooting

• Redirect not working? Ensure your repository is named exactly username.github.io and GitHub Pages is enabled
• Need to change the redirect delay? Modify the content="0;url=..." value (0 = immediate)
• Want to customize the loading page? Edit the HTML content before the meta redirect tag

License

Feel free to use this template for your own projects!

Support

Have questions? Check the GitHub Pages documentation or open an issue in this repository.

---

Made by Stux.Cloud

Stux.Cloud is part of the Stux.Group Brand of Companies.