GitHub Pages

Change Platform:

Enable GitHub Pages

GitHub Pages lets you publish a website directly from your repository. To enable it:

1. Create a new repository named your-username.github.io.
2. Add your website files (like index.html) to the repository.
3. Push your changes to GitHub.

Example

git remote add origin https://github.com/your-username/your-username.github.io.git
git push -u origin master

Set Source Branch/Folder

You can choose which branch and folder to publish. By default, GitHub uses main (or master) and the root folder. To change this:

1. Go to your repository on GitHub.
2. Click Settings > Pages.
3. Under Source, select the branch and folder (e.g., main and docs).
4. Click Save.

View Your Site

After enabling GitHub Pages, your site will be available at https://your-username.github.io/ (or your custom domain).

Click the link to see your live site!

Disable GitHub Pages

To turn off your Pages site:

1. Go to Settings > Pages.
2. Click Delete or remove the source branch/folder.
3. Optionally, delete the repository if you no longer need it.

Example

git push origin --delete gh-pages