Skip to content

Latest commit

 

History

History
136 lines (95 loc) · 3.92 KB

DEPLOYMENT_INSTRUCTIONS.md

File metadata and controls

136 lines (95 loc) · 3.92 KB

Deployment Instructions for GitHub Pages

Step 1: Create GitHub Repository

  1. Go to GitHub and log in with the account LiloUW
  2. Click the "+" icon in the top right and select "New repository"
  3. Name the repository: LiloUW.github.io (this must be the exact name for a user site)
  4. Set the repository to Public
  5. Do NOT initialize with README, .gitignore, or license (we already have these)
  6. Click "Create repository"

Step 2: Push Your Local Repository to GitHub

After creating the repository on GitHub, run these commands in your terminal:

# Navigate to your project directory (if not already there)
cd "/Users/dpozzo/Claude Code /Pozzo Website"

# Set your default branch to main (recommended)
git branch -M main

# Add the GitHub repository as remote origin
git remote add origin https://github.com/LiloUW/LiloUW.github.io.git

# Push your code to GitHub
git push -u origin main

You may be prompted to log in to GitHub. Use your GitHub credentials.

Step 3: Enable GitHub Pages

  1. Go to your repository on GitHub: https://github.com/LiloUW/LiloUW.github.io
  2. Click on "Settings" (gear icon) in the top menu
  3. In the left sidebar, click "Pages" under "Code and automation"
  4. Under "Build and deployment":
    • Source: Select "Deploy from a branch"
    • Branch: Select "main" and folder "/ (root)"
    • Click "Save"

Step 4: Wait for Deployment

GitHub Pages will automatically build and deploy your site. This may take a few minutes.

  • You can check the deployment status in the "Actions" tab of your repository
  • Once complete, your site will be live at: https://LiloUW.github.io

Step 5: Verify Your Website

  1. Visit https://LiloUW.github.io in your browser
  2. Check that all pages are working:
    • Home page with your bio
    • Publications page
    • Students/Research Group page
    • About page

Updating Your Website

To make changes to your website in the future:

  1. Edit the files locally
  2. Commit your changes: 
    git add .
git commit -m "Description of your changes"
  3. Push to GitHub: 
    git push
  4. GitHub Pages will automatically rebuild and deploy your site

Customization Tips

Adding Profile Pictures for Students

  1. Create an assets/images/students/ directory in your repository
  2. Add student profile photos (preferably square, 300x300px or larger)
  3. Update students.md to include image references: 
    ![Student Name](/assets/images/students/student-name.jpg)

Updating Your Bio or Contact Information

Edit index.md or about.md and push the changes to GitHub.

Adding New Publications

Edit publications.md following the existing format, then commit and push.

Changing the Theme

To customize the appearance:

  1. Edit _config.yml to change theme settings
  2. Create custom CSS in assets/css/style.scss
  3. Refer to the Minima theme documentation

Troubleshooting

Site not updating after push:

  • Check the Actions tab for build errors
  • Ensure your changes were actually pushed: git status should show "nothing to commit, working tree clean"

404 errors:

  • Verify the repository name is exactly LiloUW.github.io
  • Check that GitHub Pages is enabled in Settings > Pages

Theme not rendering correctly:

  • Make sure the Gemfile is committed and pushed
  • GitHub Pages may take 5-10 minutes to rebuild after changes

Testing Locally (Optional)

To preview your site locally before pushing:

# Install dependencies (first time only)
bundle install

# Run the local server
bundle exec jekyll serve

# Visit http://localhost:4000 in your browser

Support

Note: If you encounter any issues or need to make significant changes, feel free to reach out for assistance!