Redirecting GitHub Pages after a repository move
You have a repository, call it
alice/repo. You would like to transfer it to the user
bob, so it will become
However, you make heavy use of the GitHub Pages feature, so that people are often accessing
https://alice.github.io/repo/. GitHub will helpfully redirect all of your repository stuff hosted on github.com after the move, but will not redirect the GitHub Pages hosted on github.io.
We solve this by:
- Moving the repository, thus breaking all the links
- Creating a new user GitHub Pages site for Alice (not project GitHub pages site), at
- Adding a file
repo/index.htmlto the user GitHub pages site, which uses
<meta http-equiv="refresh">to redirect to the new URL.
This means that
https://alice.github.io/repo/ still exists as a working URL, even though the
alice/repo repository does not. And it will redirect to the new URL, at
To create a new user GitHub pages site for Alice, Alice will just create a new repository on GitHub named
alice.github.io, with a single branch
gh-pages. This should work out of the box, although if it doesn't, Alice can check the settings tab for that repository to make sure it's publishing to GitHub Pages.
The file at
repo/index.html in the
alice/alice.github.io repository should look like this:
<!DOCTYPE html> <meta charset="utf-8"> <title>Redirecting to https://bob.github.io/repo/</title> <meta http-equiv="refresh" content="0; URL=https://bob.github.io/repo/"> <link rel="canonical" href="https://bob.github.io/repo/">