Jekyll on Windows
While Windows is not an officially-supported platform, it can be used to run Jekyll with the proper tweaks. This page aims to collect some of the general knowledge and lessons that have been unearthed by Windows users.
A quick way to install Jekyll is to follow the installation instructions by David Burela:
- Install a package manager for Windows called Chocolatey
- Install Ruby via Chocolatey:
choco install ruby -y
- Reopen a command prompt and install Jekyll:
gem install jekyll
For a more conventional way of installing Jekyll you can follow this complete guide to install Jekyll 3 on Windows by Sverrir Sigmundarson.
If you use UTF-8 encoding, make sure that no
characters exist in your files or very, very bad things will happen to
Jekyll. This is especially relevant if you’re running Jekyll on Windows.
Additionally, you might need to change the code page of the console window to UTF-8 in case you get a “Liquid Exception: Incompatible character encoding” error during the site generation process. It can be done with the following command:
$ chcp 65001
As of v1.3.0, Jekyll uses the
listen gem to watch for changes when the
--watch switch is specified during a build or serve. While
built-in support for UNIX systems, it requires an extra gem for compatibility
with Windows. Add the following to the Gemfile for your site:
gem 'wdm', '~> 0.1.0' if Gem.win_platform?
How to install github-pages
This section is part of an article written by Jens Willmer. To follow the instructions you need to have Chocolatey installed on your system. If you already have a version of Ruby installed you need to uninstall it before you can continue.
Install Ruby and Ruby development kit
Open a command prompt and execute the following commands:
choco install ruby -version 2.2.4
choco install ruby2.devkit- needed for compilation of json gem
Configure Ruby development kit
The development kit did not set the environment path for Ruby so we need to do it.
- Open command prompt in
ruby dk.rb initto create a file called
- Edit the
config.ymlfile and include the path to Ruby
- Execute the following command to set the path:
ruby dk.rb install
Nokogiri gem installation
This gem is also needed in the github-pages and to get it running on Windows x64 we have to install a few things.
Note: In the current pre release it works out of the box with Windows x64 but this version is not referenced in the github-pages.
choco install libxml2 -Source "https://www.nuget.org/api/v2/"
choco install libxslt -Source "https://www.nuget.org/api/v2/"
choco install libiconv -Source "https://www.nuget.org/api/v2/"
gem install nokogiri --^ --with-xml2-include=C:\Chocolatey\lib\libxml220.127.116.11.7\build\native\include^ --with-xml2-lib=C:\Chocolatey\lib\libxml2.redist.18.104.22.168\build\native\bin\v110\x64\Release\dynamic\cdecl^ --with-iconv-include=C:\Chocolatey\lib\libiconv.22.214.171.124\build\native\include^ --with-iconv-lib=C:\Chocolatey\lib\libiconv.redist.126.96.36.199\build\native\bin\v110\x64\Release\dynamic\cdecl^ --with-xslt-include=C:\Chocolatey\lib\libxslt.188.8.131.52\build\native\include^ --with-xslt-lib=C:\Chocolatey\lib\libxslt.redist.184.108.40.206\build\native\bin\v110\x64\Release\dynamic
- Open command prompt and install Bundler:
gem install bundler
- Create a file called
Gemfilewithout any extension in your root directory of your blog
- Copy & paste the two lines into the file:
source 'https://rubygems.org' gem 'github-pages', group: :jekyll_plugins
- Note: We use an unsecure connection because SSL throws exceptions in the version of Ruby
- Open a command prompt, target your local blog repository root, and install github-pages:
After this process you should have github-pages installed on your system and you can host your blog again with
There will be a warning on startup that you should include
gem 'wdm', '>= 0.1.0' if Gem.win_platform? to your
Gemfile but I could not get
jekyll s working if I include that line so for the moment I ignore that warning.
In the future the installation process of the github-pages should be as simple as the setup of the blog. But as long as the new version of the Nokogiri (v1.6.8) is not stable and referenced, it is work to get it up and running on Windows.