Introduction

Jekyll, a simple, blog-aware, static site generator, is very easy to set up on Mac OS X or Linux. On Windows, not so much. This site is here to help.

Please note: Using Jekyll on Windows is not officially supported by the Jekyll team. And while this guide is featured on the Jekyll website, it remains unofficial.

Click the big button below to get started and go through the installation process step by step or select a specific step from the sidebar on the left.

Get started »

Versions

If you follow this guide step by step, you'll end up with the following software versions. These have been tested and work with Jekyll on Windows.

Versions that have been successfully tested in the past are also listed in the third column. It is generally encouraged to keep your Gems updated (up to the versions indicated below) by regularly running gem update && gem cleanup.

Software (package) Version Also tested
Ruby 2.0.0p576 2.0.0p481
Jekyll 2.5.1 2.4.0 2.3.0 2.2.0 2.1.1 2.1.0
listen 2.7.11 N/A
wdm 0.1.0 N/A
If you use Pygments for syntax highlighting:
pygments.rb 0.6.0 N/A
Python 2.7.8 N/A
pip 1.5.6 N/A
setuptools 5.4.1 N/A
Pygments 1.6 N/A
If you use Rouge for syntax highlighting:
Rouge 1.7.3 1.7.2 1.6.2 1.6.1 1.5.1 1.4.0

Portable Jekyll

@madhur has created Portable Jekyll. Refer to the project's documentation for more information on how to install and use it. Please note that Portable Jekyll may not always be up to date with the latest version of Jekyll out of the box.