Development Setup
There are three supported ways to test the site:
- Windows + WSL (Current)
- Any + Docker (Planned)
- Local (Planned)
1. Windows + WSL
Prerequisites
We recommend using WSL (Windows Subsystem for Linux) for the best compatibility with Jekyll on Windows.
1. Verification
Ensure WSL is installed (PowerShell):
wsl --version
2. Install Ruby & Jekyll (using WSL)
- Check if already installed:
wsl bash -ic 'gem list jekyll' - Update & Install Ruby:
wsl -u root bash -ic 'apt update' wsl -u root bash -ic 'apt install ruby-full build-essential zlib1g-dev' - Configure Gem Path (avoids using sudo for gems):
$foundSetup = wsl bash -ic "grep '# Install Ruby Gems to ~/gems' ~/.bashrc | wc -l" if ($foundSetup -eq 0) { echo '# Install Ruby Gems to ~/gems' | wsl bash -ic 'tee -a ~/.bashrc' echo 'export GEM_HOME="~/gems"' | wsl bash -ic 'tee -a ~/.bashrc' echo 'export PATH="~/gems/bin:$PATH"' | wsl bash -ic 'tee -a ~/.bashrc' } - Install Jekyll & Bundler:
wsl bash -ic 'gem install jekyll bundler'
Running
- Install Dependencies:
Open PowerShell in the project directory:
wsl bash -ic 'bundle install' - Start Server:
This command will NOT exit until the server is stopped. To stop the server, press
Ctrl+C.wsl bash -ic 'bundle exec jekyll serve --livereload' - View Site: Open http://localhost:4000 in your Windows browser.
2. Any + Docker
Details coming soon.
3. Local
Details coming soon.