Skip to content

Deploying a Free Static Website with Jekyll and GitHub Pages (WIP)

Suhas Kadhane edited this page Sep 2, 2025 · 1 revision

Introduction

What is Jekyll

  • Brief overview: What Jekyll is, what GitHub Pages is, and why this combo matters.
  • Who it’s for: beginners, bloggers, or devs looking for free hosting.
  • End goal: user will have a live website at username.github.io.

Prerequisites

  • GitHub account
  • Git installed locally
  • Basic terminal knowledge (optional but helpful)
  • (Optional) Ruby installed if customizing Jekyll locally

Step-by-Step Walkthrough

Step-by-Step Walkthrough

  1. Set up GitHub Repo

    • Create a repo named username.github.io
    • Initialize with README
  2. Install Jekyll (optional for local testing)

  • Instructions for installing Ruby + Jekyll (with links to official docs)
  1. Choose a Jekyll Theme
  • Easiest: pick a prebuilt theme from GitHub Pages themes
  • Alternative: clone a theme repo
  1. Push Files to GitHub
  • Add theme files to repo
  • Commit and push
  1. Enable GitHub Pages
  • Settings → Pages → Select branch
  • Site goes live at username.github.io
  1. Verify Site
  • Visit link and check output
  1. (Optional) Add Custom Domain
  • Steps for domain setup + DNS changes

Troubleshooting

Common issues (e.g., theme not rendering, 404 error, Ruby install issues).

Conclusion

  • What user has achieved
  • Benefits of static site hosting
  • Next steps: customizing theme, adding blog posts

Clone this wiki locally