This repository contains my personal website built with Jekyll using the Minima theme. This guide explains how to set up the website locally, install dependencies, and run Jekyll to preview changes.
Follow these steps to clone and set up the website on a new computer.
Ensure your system has the following installed:
- Ruby (version 3.x recommended)
- Bundler (Ruby package manager)
- Jekyll
-
On macOS (with Homebrew):
brew install ruby gem install bundler
-
On Ubuntu / Debian:
sudo apt update sudo apt install ruby-full build-essential zlib1g-dev gem install bundler
-
On Windows:
- Install RubyInstaller from rubyinstaller.org
- After installation, open a terminal and run:
gem install bundler
git clone https://github.com/your-username/your-repo.git
cd your-repo
Inside the project directory, run:
bundle install
This installs all required Jekyll plugins and dependencies.
To preview the website on localhost:4000
, use:
bundle exec jekyll serve
If successful, you should see output like: Server address: http://127.0.0.1:4000
Open your browser and visit http://127.0.0.1:4000
.
To test the website as a fresh build, use:
bundle exec jekyll build --clean
This regenerates the site and removes old cached files.
If jekyll serve
fails, try:
bundle update
bundle exec jekyll serve
If Sass-related warnings appear (e.g., deprecation messages for darken()
and
lighten()
), downgrade sassc
with:
gem install sassc -v "~> 2.0"
bundle update jekyll-sass-converter
If making changes, commit and push to GitHub:
git add .
git commit -m "Updated content"
git push origin main
If hosting via GitHub Pages, the site will automatically update.
If anything goes wrong, reset your local setup:
rm -rf _site .jekyll-cache
bundle exec jekyll clean
bundle install
bundle exec jekyll serve
- If you switch computers, just clone the repo and repeat steps 1-3.
- Always run
bundle install
after pulling new changes. - To ensure compatibility, use Ruby 3.x and avoid unnecessary Sass updates.
✅ Now your setup is documented! If you ever switch to a new computer, just follow these steps. 🚀