Installation on Windows platform

Following packages are required to setup Jekyll :

Ruby & Ruby Development Kit
Jekyll
Python & easy_install
Pygments
Test drive your jekyll setup

Install Ruby and Dev Kit

Download Ruby 1.9.3-p429 from http://rubyinstaller.org/downloads/
- Launch the installer
- The installer should propose C:\Ruby193 as the target folder
- There’s no need to select any specific option
Download Ruby 1.9.3-p429 from http://rubyinstaller.org/downloads/
- Launch the installer
- Select C:\Ruby193\DevKit as path for extraction
Launch the Start Command Prompt with Ruby and generate the devkit config.yml file using the following command.

ruby 1.9.3p429 (2013-05-15) [i386-mingw32]

C:\Users\your_name>cd C:\Ruby193\DevKit

C:\Ruby193\DevKit>ruby dk.rb init
[INFO] found RubyInstaller v1.9.3 at C:/Ruby193

Initialization complete! Please review and modify the auto-generated
'config.yml' file to ensure it contains the root directories to all
of the installed Rubies you want enhanced by the DevKit.

C:\Ruby193\DevKit>

Edit the generated config.yml file

C:\Ruby193\DevKit>notepad C:\Ruby193\DevKit\config.yml

Ensure that the version of Ruby that has just been installed is now referenced. The file should look like the following

# This configuration file contains the absolute path locations of all
# installed Rubies to be enhanced to work with the DevKit. This config
# file is generated by the 'ruby dk.rb init' step and may be modified
# before running the 'ruby dk.rb install' step. To include any installed
# Rubies that were not automagically discovered, simply add a line below
# the triple hyphens with the absolute path to the Ruby root directory.
#
# Example:
#
# ---
# - C:/ruby19trunk
# - C:/ruby192dev
#
---
- C:/Ruby193

Run the following command to check the configuration file

C:\Ruby193\DevKit>ruby dk.rb review
Based upon the settings in the 'config.yml' file generated
from running 'ruby dk.rb init' and any of your customizations,
DevKit functionality will be injected into the following Rubies
when you run 'ruby dk.rb install'.

C:/Ruby193

C:\Ruby193\DevKit>

Run the following command to inject DevKit in all listed Ruby versions.

C:\Ruby193\DevKit>ruby dk.rb install
[INFO] Updating convenience notice gem override for 'C:/Ruby193'
[INFO] Installing 'C:/Ruby193/lib/ruby/site_ruby/devkit.rb'

C:\Ruby193\DevKit>

Install Jekyll

In order to be as compatible as possible with GitHub’s Pages servers, check the recommended version of the jekyll gem to install.
Install the recommended version (1.0.3 as of today)

C:\Ruby193\DevKit>gem install --version '= 1.0.3' jekyll
Fetching: liquid-2.5.0.gem (100%)
Fetching: fast-stemmer-1.0.2.gem (100%)
...
Installing RDoc documentation for safe_yaml-0.7.1...
Installing RDoc documentation for colorator-0.1...
Installing RDoc documentation for jekyll-1.0.3...

C:\Ruby193\DevKit>

Install Python

Download Python 2.7.5 from http://www.python.org/download/
Launch the installer
The installer should propose C:\Python27 as the target folder
Add C:\Python27 to the PATH environement variable
Close and launch again the Start Command Prompt with Ruby to make it know about the changes to the PATH environment variable
Ensure python.exe is reachable

ruby 1.9.3p429 (2013-05-15) [i386-mingw32]

C:\Users\your_name>python --version
Python 2.7.5

C:\Users\your_name>

Download the distribute python module
- Download the file from http://python-distribute.org/distribute_setup.py
- Store it in the C:\Python27\Tools folder
Launch distribute to install easy_install

C:\Users\your_name>python C:\Python27\Tools\distribute_setup.py

[TODO]: check the first lines of installation
...
Creating c:\Python27\Lib\site-packages\setuptools-0.6c11-py2.7.egg-info
Creating c:\Python27\Lib\site-packages\setuptools.pth

C:\Users\your_name>

Install Pygments

Run the following command

C:\Users\your_name>C:\Python27\Scripts\easy_install.exe Pygments
Searching for Pygments
Reading http://pypi.python.org/simple/Pygments/
Best match: Pygments 1.6
...
Processing dependencies for Pygments
Finished processing dependencies for Pygments

C:\Users\your_name>

Test drive your jekyll setup

Run the following commands

C:\Users\your_name>cd /D %TMP%

C:\Users\your_name\AppData\Local\Temp>jekyll new my_test
New jekyll site installed in C:/Users/your_name/AppData/Local/Temp/my_test.

C:\Users\your_name\AppData\Local\Temp>cd my_test

C:\Users\your_name\AppData\Local\Temp\my_test>jekyll server
Configuration file: C:/Users/your_name/AppData/Local/Temp/my_test/_config.yml
            Source: C:/Users/your_name/AppData/Local/Temp/my_test
       Destination: C:/Users/your_name/AppData/Local/Temp/my_test/_site
      Generating... done.
[2013-06-18 12:17:36] INFO  WEBrick 1.3.1
[2013-06-18 12:17:36] INFO  ruby 1.9.3 (2013-05-15) [i386-mingw32]
[2013-06-18 12:17:36] INFO  WEBrick::HTTPServer#start: pid=14100 port=4000

Open a browser and enter the following URL http://localhost:4000
Profit!

Congratulation! your environment is now ready to contribute to the LibGit2Sharp documentation