🎓 Create an Academic Website with AcademicPages on GitHub Pages

Table of Contents

• 🎓 Create an Academic Website with AcademicPages on GitHub Pages
  • Table of Contents
  • 📌 1. Fork the AcademicPages Repository
  • 📌 2. Rename the Repository
  • 📌 3. Enable GitHub Pages
  • 📌 4. Clone the Repository Locally
  • 📌 5. Install Jekyll Locally (Optional)
    • 🔹 Windows
    • 🔹 macOS / Linux
    • Run Jekyll Locally
  • 📌 6. Customize Your Site
    • 📝 Edit _config.yml
    • 📄 Edit Pages
    • ✏️ Adding Blog Posts
  • 📌 7. Commit and Push Changes to GitHub
  • 📌 8. Set a Custom Domain (Optional)
  • 🔄 Updating the AcademicPages Template
  • 🎯 Troubleshooting
    • ❌ Website Not Showing?
    • ❌ Jekyll Errors Locally?
  • 📚 More Resources

---

📌 1. Fork the AcademicPages Repository

• Go to the AcademicPages GitHub repository.
• Click Fork (top right corner) to create a copy in your GitHub account.

📌 2. Rename the Repository

• Go to Settings → Rename the repository to miftah-ahmad-choiri.github.io (replace miftah-ahmad-choiri with your GitHub username).
• This is required for GitHub Pages to host the website.

📌 3. Enable GitHub Pages

• Navigate to Settings → Pages.
• Under Source, select main branch and save.
• Your website will be available at https://miftah-ahmad-choiri.github.io in a few minutes.

📌 4. Clone the Repository Locally

Open a terminal or command prompt and run:

git clone https://github.com/username/username.github.io
cd username.github.io

📌 5. Install Jekyll Locally (Optional)

If you want to test the website locally before pushing changes:

🔹 Windows

• Install Ruby via RubyInstaller
• Install Bundler and Jekyll:

gem install jekyll bundler

🔹 macOS / Linux

• Install Ruby and Jekyll:

brew install ruby
gem install jekyll bundler

Run Jekyll Locally

bundle exec jekyll serve

Visit http://localhost:4000 to preview.

📌 6. Customize Your Site

📝 Edit _config.yml

Modify _config.yml to change:

• Site title, author, email, and social links.

title: "Your Name"
author: "Your Name"
email: "your-email@example.com"
github_username: "your-github"
linkedin_username: "your-linkedin"

📄 Edit Pages

Modify the Markdown files in the repository:

• index.md → Home Page
• _pages/cv.md → CV Page
• _pages/publications.md → Publications Page
• _pages/blog.md → Blog Page

✏️ Adding Blog Posts

Create Markdown files inside _posts/:

---
title: "My First Blog Post"
date: 2025-02-02
author: "Your Name"
---
Welcome to my first blog post!

📌 7. Commit and Push Changes to GitHub

git add .
git commit -m "Customized AcademicPages site"
git push origin main

📌 8. Set a Custom Domain (Optional)

1. Buy a domain (e.g., from Namecheap).
2. Add a CNAME file in the repository with your domain name.
3. Configure DNS records to point to GitHub Pages.

🔄 Updating the AcademicPages Template

If the original AcademicPages repository updates, sync your fork:

git remote add upstream https://github.com/academicpages/academicpages.github.io
git fetch upstream
git merge upstream/main
git push origin main

---

🎯 Troubleshooting

❌ Website Not Showing?

• Check Settings → Pages in GitHub.
• Ensure main branch is selected as the source.

❌ Jekyll Errors Locally?

• Run bundle install before bundle exec jekyll serve.
• Ensure you have the correct Ruby and Bundler versions.

---

📚 More Resources

• 🔹 AcademicPages GitHub
• 🔹 GitHub Pages Docs
• 🔹 Jekyll Docs

🚀 Enjoy your academic website! 🎉

---

✅ Now you can copy and paste this directly into a Markdown file (README.md) or into your GitHub repository! Let me know if you need any improvements! 🚀