diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 648256e10..1650f68cc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -142,6 +142,28 @@ docker build -t aider -f docker/Dockerfile . The project's documentation is built using Jekyll and hosted on GitHub Pages. To build the documentation locally, follow these steps: 1. Install Ruby and Bundler (if not already installed). + + For Ubuntu/Debian: + ```bash + sudo apt update + sudo apt install ruby ruby-dev + gem install bundler + ``` + + For macOS: + ```bash + # Using Homebrew + brew install ruby + gem install bundler + ``` + + For Windows: + 1. Download the Ruby installer from https://rubyinstaller.org/ + 2. Run the installer + 3. Open a new terminal and run: `gem install bundler` + + You can verify your installation with: `ruby --version` and `bundler --version` + 2. Navigate to the `aider/website` directory. 3. Install the required gems: ```