Skip to content

Local Documentation Setup (Windows)

This guide explains how to set up the documentation locally on Windows for testing before deployment.

You don't need to install Ruby locally! GitHub Actions will automatically build and deploy your documentation when you push changes. Simply:

  1. Edit markdown files in the docs/ directory
  2. Commit and push to GitHub
  3. GitHub Actions will build and deploy automatically

Option 2: Install Ruby for Local Testing

If you want to preview the documentation locally before pushing:

Install Ruby on Windows

  1. Download RubyInstaller:
  2. Visit: https://rubyinstaller.org/
  3. Download Ruby+Devkit 3.1.x (recommended)

  4. Run the installer

  5. Verify Installation: 

    ruby --version
gem --version

  6. Install Bundler: 

    gem install bundler

  7. Install Jekyll Dependencies: 

    cd docs
bundle install

  8. Run Local Server: 

    bundle exec jekyll serve

  9. View Documentation:

  10. Open http://localhost:4000 in your browser

Troubleshooting

If bundle install fails: - Make sure you installed Ruby+Devkit (not just Ruby) - Run the MSYS2 installer that comes with Ruby+Devkit - Restart PowerShell after installation

If Jekyll fails to start: - Ensure all dependencies installed: bundle install - Check Ruby version: ruby --version (should be 3.1.x or compatible)

Alternative: Use Docker

If you prefer not to install Ruby directly:

# Using Docker (if you have Docker Desktop installed)
docker run --rm -it -v ${PWD}:/srv/jekyll -p 4000:4000 jekyll/jekyll:latest jekyll serve

Then open http://localhost:4000

For most users, we recommend:

  1. Edit documentation in your editor
  2. Commit and push to GitHub
  3. Let GitHub Actions build and deploy
  4. View the live site at: https://dmytro-yemelianov.github.io/raps/

This avoids local setup complexity while still allowing you to edit and deploy documentation easily.