GitHub Pages Deployment Guide

๐Ÿšจ Current Issue: Fork Repository Limitations

This repository is a fork of an academic homepage template. GitHub Pages has specific limitations for forked repositories that may prevent your site from being publicly accessible at https://tangenth.github.io.

โœ… Quick Fix: Enable GitHub Pages for Your Fork

  1. Go to your repository on GitHub: https://github.com/TangentH/TangentH.github.io
  2. Click on Settings tab
  3. Scroll down to Pages section in the left sidebar
  4. Under Source, select:
    • Source: Deploy from a branch
    • Branch: main
    • Folder: / (root)
  5. Click Save
  6. Wait 5-10 minutes for deployment

Method 2: Convert Fork to Standalone Repository (Best Long-term Solution)

  1. Create a new repository named TangentH.github.io (delete the current fork first)
  2. Clone this repository locally
  3. Push the code to the new repository
  4. Enable GitHub Pages as described in Method 1

๐Ÿ”ง Configuration Fixes Applied

Fixed Repository Reference

  • โœ… Updated _config.yml to point to correct repository: TangentH/TangentH.github.io
  • โœ… This enables Google Scholar stats and other features that depend on repository path

Removed CNAME Issues

  • โœ… Confirmed no conflicting CNAME file exists
  • โœ… Site will deploy to default tangenth.github.io domain

๐Ÿงช Testing Your Deployment

After enabling GitHub Pages:

  1. Check Actions Tab: Look for โ€œpages build and deploymentโ€ workflow runs
  2. Visit Your Site: Navigate to https://tangenth.github.io
  3. Verify Features:
    • Homepage loads correctly
    • Navigation works
    • Google Scholar stats appear (if configured)

๐Ÿš€ Additional Optimizations

Enable Google Scholar Stats

  1. Uncomment and configure the Google Scholar crawler workflow
  2. Add your Google Scholar ID to repository secrets
  3. The workflow will automatically update citation statistics

Custom Domain (Optional)

If you want to use a custom domain:

  1. Add a CNAME file with your domain name
  2. Configure DNS settings with your domain provider
  3. Enable HTTPS in repository settings

๐Ÿ” Troubleshooting

Site Still Not Accessible?

  • Check if GitHub Pages is enabled in repository settings
  • Verify the repository is public
  • Wait up to 10 minutes for changes to propagate
  • Check browser cache (try incognito mode)

Build Failures?

  • Check the Actions tab for error details
  • Ensure all required files are present
  • Verify Jekyll syntax in _config.yml
  • Consider converting to a standalone repository
  • Check if the original repository has any specific deployment requirements

๐Ÿ“ž Need More Help?

If issues persist:

  1. Check GitHub Pages documentation
  2. Verify repository settings match this guide
  3. Consider reaching out to GitHub Support for fork-specific issues

Last Updated: September 2024
Status: Ready for deployment after applying fixes