From c2ee828ad6cd23169ef13f279590f6e3e408cb88 Mon Sep 17 00:00:00 2001 From: Jens Willmer Date: Thu, 2 Jun 2016 22:19:40 +0300 Subject: [PATCH 1/5] Added link to windows doc page --- site/_docs/github-pages.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/site/_docs/github-pages.md b/site/_docs/github-pages.md index cfe8822a..02ec1c8d 100644 --- a/site/_docs/github-pages.md +++ b/site/_docs/github-pages.md @@ -79,6 +79,16 @@ gem 'github-pages'

+
+
Installing github-pages gem on Windows
+

+ While Windows is not officially supported, it is possible + to install github-pages gem on Windows. + Special instructions can be found on our + Windows-specific docs page. +

+
+ ### User and Organization Pages User and organization pages live in a special GitHub repository dedicated to From bbbbb2e7044611a62fc7ea9def275767f9a837be Mon Sep 17 00:00:00 2001 From: Jens Willmer Date: Thu, 2 Jun 2016 22:36:07 +0300 Subject: [PATCH 2/5] Installation instructions for github-pages gem --- site/_docs/windows.md | 71 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/site/_docs/windows.md b/site/_docs/windows.md index ec98dcde..06935863 100644 --- a/site/_docs/windows.md +++ b/site/_docs/windows.md @@ -44,3 +44,74 @@ with Windows. Add the following to the Gemfile for your site: {% highlight ruby %} gem 'wdm', '~> 0.1.0' if Gem.win_platform? {% endhighlight %} + +### How to install github-gem + +This section is part of an article written by [Jens Willmer][jwillmerPost]. 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 `C:\tools\DevKit2` + * Execute `ruby dk.rb init` to create a file called `config.yml` + * Edit the `config.yml` file and include the path to Ruby `- C:/tools/ruby22` + * Execute the following command to set the path: `ruby dk.rb install` + +#### Nokogiri gem installation + +This gem is also needed in the github-gem and to get it running on Windows x64 we have to install a few things. + + +**Note:** In the current [pre release][nokogiriFails] it works out of the box with Windows x64 but this version is not referenced in the github-gem. + + +`cinst -Source "https://go.microsoft.com/fwlink/?LinkID=230477" libxml2`{:.language-ruby} + +`cinst -Source "https://go.microsoft.com/fwlink/?LinkID=230477" libxslt`{:.language-ruby} + +`cinst -Source "https://go.microsoft.com/fwlink/?LinkID=230477" libiconv`{:.language-ruby} + +```language-ruby + gem install nokogiri --^ + --with-xml2-include=C:\Chocolatey\lib\libxml2.2.7.8.7\build\native\include^ + --with-xml2-lib=C:\Chocolatey\lib\libxml2.redist.2.7.8.7\build\native\bin\v110\x64\Release\dynamic\cdecl^ + --with-iconv-include=C:\Chocolatey\lib\libiconv.1.14.0.11\build\native\include^ + --with-iconv-lib=C:\Chocolatey\lib\libiconv.redist.1.14.0.11\build\native\bin\v110\x64\Release\dynamic\cdecl^ + --with-xslt-include=C:\Chocolatey\lib\libxslt.1.1.28.0\build\native\include^ + --with-xslt-lib=C:\Chocolatey\lib\libxslt.redist.1.1.28.0\build\native\bin\v110\x64\Release\dynamic +``` + +#### Install github-gem + + * Open command prompt and install [Bundler][]: `gem install bundler` + * Create a file called `Gemfile` without any extension in your root directory of your blog + * Copy & past the two lines into the file: + + +```language-ruby +source 'http://rubygems.org' +gem 'github-pages' +``` + + * **Note:** We use an unsecure connection because SSL throws exceptions in the version of Ruby + * Open a command prompt and install github-pages: `bundle install` + + +After this process you should have github-pages installed on your system and you can host your blog again with `jekyll s`. \\ +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-gem should be as simple as the setup of the blog. But as long as the new version of the Nokogiri ([v1.6.8][nokogiriReleases]) is not stable and referenced, it is work to get it up and running on Windows. + +[jwillmerPost]: http://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46 "Installation instructions by Jens Willmer" +[Chocolatey]: https://chocolatey.org/install "Package manager for Windows" +[Bundler]: http://bundler.io/ "Ruby Dependencie Manager" +[nokogiriReleases]: https://github.com/sparklemotion/nokogiri/releases "Nokogiri Releases" +[nokogiriFails]: https://github.com/sparklemotion/nokogiri/issues/1456#issuecomment-206481794 "Nokogiri fails to install on Ruby 2.3 for Windows" From d68ddf9dace0a7ddb1a10ecf1059d6a6ab519da4 Mon Sep 17 00:00:00 2001 From: Jens Willmer Date: Thu, 2 Jun 2016 22:46:05 +0300 Subject: [PATCH 3/5] Included installation instructions --- site/_docs/windows.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/site/_docs/windows.md b/site/_docs/windows.md index 06935863..d3fd8254 100644 --- a/site/_docs/windows.md +++ b/site/_docs/windows.md @@ -10,12 +10,14 @@ knowledge and lessons that have been unearthed by Windows users. ## Installation -Julian Thilo has written up instructions to get -[Jekyll running on Windows][windows-installation] and it seems to work for most -people. The instructions were written for Ruby 2.0.0, but should work for later -versions [prior to 2.2][hitimes-issue]. +A quick way to install Jekyll it to follow the [installation instructions by David Burela](https://davidburela.wordpress.com/2015/11/28/easily-install-jekyll-on-windows-with-3-command-prompt-entries-and-chocolatey/): -Alternatively David Burela has written instructions on [how to install Jekyll via Chocolatey with 3 command prompt entries](https://davidburela.wordpress.com/2015/11/28/easily-install-jekyll-on-windows-with-3-command-prompt-entries-and-chocolatey/). + 1. Install a package manager for Windows called [Chocolatey](https://chocolatey.org/install) + 2. Install Ruby via Chocolatey: `choco install ruby -y` + 3. Reopen a command prompt and install Jekyll: `gem install jekyll` + +For a more conventional way of installing Jekyll you can follow the [installation instruction by Julian Thilo][windows-installation]. The instructions were written for Ruby 2.0.0, but should work for later +versions [prior to 2.2][hitimes-issue]. ## Encoding From 3a8025cb08ceb0b09c57780e0dee93cae18c199b Mon Sep 17 00:00:00 2001 From: Jens Willmer Date: Thu, 2 Jun 2016 23:33:20 +0300 Subject: [PATCH 4/5] Changed github-gem to github-pages The gem is technically called github-pages as noted by @parkr in the [pull request](https://github.com/jekyll/jekyll/pull/4977#discussion_r65610202) --- site/_docs/windows.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/site/_docs/windows.md b/site/_docs/windows.md index d3fd8254..02ea233d 100644 --- a/site/_docs/windows.md +++ b/site/_docs/windows.md @@ -47,7 +47,7 @@ with Windows. Add the following to the Gemfile for your site: gem 'wdm', '~> 0.1.0' if Gem.win_platform? {% endhighlight %} -### How to install github-gem +### How to install github-pages This section is part of an article written by [Jens Willmer][jwillmerPost]. 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. @@ -69,10 +69,10 @@ The development kit did not set the environment path for Ruby so we need to do i #### Nokogiri gem installation -This gem is also needed in the github-gem and to get it running on Windows x64 we have to install a few things. +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][nokogiriFails] it works out of the box with Windows x64 but this version is not referenced in the github-gem. +**Note:** In the current [pre release][nokogiriFails] it works out of the box with Windows x64 but this version is not referenced in the github-pages. `cinst -Source "https://go.microsoft.com/fwlink/?LinkID=230477" libxml2`{:.language-ruby} @@ -91,7 +91,7 @@ This gem is also needed in the github-gem and to get it running on Windows x64 w --with-xslt-lib=C:\Chocolatey\lib\libxslt.redist.1.1.28.0\build\native\bin\v110\x64\Release\dynamic ``` -#### Install github-gem +#### Install github-pages * Open command prompt and install [Bundler][]: `gem install bundler` * Create a file called `Gemfile` without any extension in your root directory of your blog @@ -110,7 +110,7 @@ gem 'github-pages' After this process you should have github-pages installed on your system and you can host your blog again with `jekyll s`. \\ 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-gem should be as simple as the setup of the blog. But as long as the new version of the Nokogiri ([v1.6.8][nokogiriReleases]) is not stable and referenced, it is work to get it up and running on Windows. +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][nokogiriReleases]) is not stable and referenced, it is work to get it up and running on Windows. [jwillmerPost]: http://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46 "Installation instructions by Jens Willmer" [Chocolatey]: https://chocolatey.org/install "Package manager for Windows" From d6e58623c6107e51d42b0642065a44a9913896d9 Mon Sep 17 00:00:00 2001 From: Jens Willmer Date: Fri, 3 Jun 2016 00:05:20 +0300 Subject: [PATCH 5/5] Fixed typo --- site/_docs/windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_docs/windows.md b/site/_docs/windows.md index 02ea233d..ea4c0359 100644 --- a/site/_docs/windows.md +++ b/site/_docs/windows.md @@ -10,7 +10,7 @@ knowledge and lessons that have been unearthed by Windows users. ## Installation -A quick way to install Jekyll it to follow the [installation instructions by David Burela](https://davidburela.wordpress.com/2015/11/28/easily-install-jekyll-on-windows-with-3-command-prompt-entries-and-chocolatey/): +A quick way to install Jekyll is to follow the [installation instructions by David Burela](https://davidburela.wordpress.com/2015/11/28/easily-install-jekyll-on-windows-with-3-command-prompt-entries-and-chocolatey/): 1. Install a package manager for Windows called [Chocolatey](https://chocolatey.org/install) 2. Install Ruby via Chocolatey: `choco install ruby -y`