From 435d0bc4ab2e01c8debe4a9e6ace6321a1902297 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Tue, 6 Aug 2013 18:46:54 +0200 Subject: [PATCH 1/6] Empty file for windows docs. --- site/docs/windows.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 site/docs/windows.md diff --git a/site/docs/windows.md b/site/docs/windows.md new file mode 100644 index 00000000..e69de29b From 12fcdd9bfa130706384fe90c28989869c4b3bd89 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Tue, 6 Aug 2013 19:14:45 +0200 Subject: [PATCH 2/6] Some beginning collection for Windows users. Leaving the office so it's a bit unkempt. --- site/docs/frontmatter.md | 3 ++- site/docs/installation.md | 7 +++---- site/docs/windows.md | 24 ++++++++++++++++++++++++ 3 files changed, 29 insertions(+), 5 deletions(-) diff --git a/site/docs/frontmatter.md b/site/docs/frontmatter.md index 98c15cc4..19156e03 100644 --- a/site/docs/frontmatter.md +++ b/site/docs/frontmatter.md @@ -30,7 +30,8 @@ relies on.

If you use UTF-8 encoding, make sure that no BOM header 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. + Jekyll. This is especially relevant if you’re running + Jekyll on Windows.

diff --git a/site/docs/installation.md b/site/docs/installation.md index 86104437..8fb82a0a 100644 --- a/site/docs/installation.md +++ b/site/docs/installation.md @@ -23,10 +23,9 @@ you’ll need to make sure your system has before you start.
Running Jekyll on Windows

- It is possible to get - - Jekyll running on Windows, but the official documentation does not - support installation on Windows platforms. + While Windows is not officially supported, it is possible to get it running + on Windows. Special instructions can be found on our + Windows-specific docs page.

diff --git a/site/docs/windows.md b/site/docs/windows.md index e69de29b..27691658 100644 --- a/site/docs/windows.md +++ b/site/docs/windows.md @@ -0,0 +1,24 @@ +--- +layout: docs +title: Jekyll on Windows +prev_section: configuration +next_section: posts +permalink: /docs/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. + +## Installation + +Madhur Ahuja has written up instructions to get +[Jekyll running on Windows][windows-installation] and it seems to work for most. + +## Encoding + +If you use UTF-8 encoding, make sure that no BOM header +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. + +[windows-installation]: http://www.madhur.co.in/blog/2011/09/01/runningjekyllwindows.html From e974370cf190721cc7cdd81719110220932ca659 Mon Sep 17 00:00:00 2001 From: Aigars Dzerviniks Date: Tue, 6 Aug 2013 21:25:41 +0200 Subject: [PATCH 3/6] Add additional information about encoding issues on Windows --- site/docs/windows.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/site/docs/windows.md b/site/docs/windows.md index 27691658..a27d5ff3 100644 --- a/site/docs/windows.md +++ b/site/docs/windows.md @@ -21,4 +21,12 @@ If you use UTF-8 encoding, make sure that no BOM header 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. + +{% highlight bash %} +$ chcp 65001 +{% endhighlight %} + [windows-installation]: http://www.madhur.co.in/blog/2011/09/01/runningjekyllwindows.html From 752a862c67fccc2b6e11ce32258fcd23de496635 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Mon, 18 Nov 2013 15:17:50 -0500 Subject: [PATCH 4/6] Add note about auto-regeneration --- site/docs/windows.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/site/docs/windows.md b/site/docs/windows.md index a27d5ff3..243a4395 100644 --- a/site/docs/windows.md +++ b/site/docs/windows.md @@ -23,10 +23,17 @@ 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. +the site generation process. It can be done with the following command: {% highlight bash %} $ chcp 65001 {% endhighlight %} [windows-installation]: http://www.madhur.co.in/blog/2011/09/01/runningjekyllwindows.html + +## Auto-regeneration + +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 `listen` has +built-in support for UNIX systems, it requires an extra gem for compatibility +with Windows. Add the following to the Gemfile for your site: From cbdadc83a192d630d4c0918d53412f4f57b4457b Mon Sep 17 00:00:00 2001 From: David Silva Smith Date: Mon, 18 Nov 2013 15:20:23 -0500 Subject: [PATCH 5/6] Add block of code which should be added to Gemfile for Windows listen compatibility. Closes https://github.com/mojombo/jekyll/pull/1720 --- site/docs/windows.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/site/docs/windows.md b/site/docs/windows.md index 243a4395..5a762b81 100644 --- a/site/docs/windows.md +++ b/site/docs/windows.md @@ -37,3 +37,8 @@ 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 `listen` has built-in support for UNIX systems, it requires an extra gem for compatibility with Windows. Add the following to the Gemfile for your site: + +{% highlight ruby %} +require 'rbconfig' +gem 'wdm', '~> 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i +{% endhighlight %} From c295060f69ba994ca48d0a98083bd2467eb42a78 Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Wed, 11 Dec 2013 18:25:02 -0500 Subject: [PATCH 6/6] Use Markdown, silly --- site/docs/windows.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/site/docs/windows.md b/site/docs/windows.md index 5a762b81..b1f12ccc 100644 --- a/site/docs/windows.md +++ b/site/docs/windows.md @@ -17,11 +17,11 @@ Madhur Ahuja has written up instructions to get ## Encoding -If you use UTF-8 encoding, make sure that no BOM header +If you use UTF-8 encoding, make sure that no `BOM` header 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 +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: