Skip to content

Local setup

Li-Wei Yap edited this page Dec 31, 2025 · 5 revisions

Local setup

Mac OS X

  • Follow installation guide here:
# install the command line tools to compile native extensions
xcode-select --install
export SDKROOT=$(xcrun --show-sdk-path)

# Install Homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install Ruby
brew install ruby

# If you're using Zsh
# echo 'export PATH="/usr/local/opt/ruby/bin:/usr/local/lib/ruby/gems/3.0.0/bin:$PATH"' >> ~/.zshrc

# https://github.com/eventmachine/eventmachine/issues/990#issuecomment-2457585644
brew install rbenv
# edit (311225): Ruby version 3.2.0 removes the deprecated Ruby function `tainted`,
# which is used in Liquid up to version 4.0.3. Fixed in version 4.0.4
# https://github.com/Shopify/liquid/issues/1625#issuecomment-1254061820
# Due to dependency hell, the only way to use Liquid version 4.0.4 is to downgrade to Ruby version 3.1.7
# so that we can use bundler version 2.6.9 (installed below using gem install bundler)
rbenv install 3.1.7
rbenv global 3.1.7
# open ~/.zshrc
eval "$(rbenv init - zsh)"

  • VERY IMPORTANT: Restart your terminal to apply your changes. Then run:
sudo gem install bundler
bundle install
  • For local testing, run:
bundle exec jekyll serve --config _config.yml,_config-dev.yml

Clone this wiki locally