GitHubへのWEBサイト作成用Markdown原稿をプレビューする環境をセットアップ

ソースリポジトリ管理サービスで一番有名であるGitHubにアカウントを取得後、GitHub上にWEBサイトを作ろうとしました。
ちなみにGitHubでは、Markdown形式の書式で書かれたWEBサイト用の原稿ファイルをアップロードすると、自動でHTMLに変換して公開する機能が提供されています。
GitHubでは、この変換にはJekyllというHTML自動生成ツールが使用されていると表記されています。

GitHubサイトにはGitHub用にカスタマイズされた公式のJekyllセットアップ手順が公開されてますが、私はJekyllについての知識がなかったため、公式の手順だけで進めた場合に盛大にハマってしまったので、やるべきことを整理しました。

このドキュメントは、このときのWindows上でJekyllを使えるようにする手順になります。

GitHubの公式手順を使ってJekyllをセットアップ

GitHubの公式ページにてまとめられているJekyllインストール手順のページと、Ruby DEVELOPMENT KITインストール手順のページに詳細に載ってはいます。

順にこなしていけばよいはずですが、Jekyllインストール手順の1番目にある関連ツールのインストールで失敗してしまってたため、後続する手順がまるで先に進めませんでした。
原因は手順に書かれていない余計な削除操作をやったためではあるのですが、書かれていなくとも普段から体に染み付いた動作であったので、説明がない点がちょっと不親切だと感じましたので、以降ではすこし補足を加えた、今回やったことを順に書いておきます。

Ruby関連ツールの対象バージョンと配布サイト

• Ruby 2.2.3 (x64)
• Ruby DEVELOPMENT KIT 4.7.2-20130224-1432-sfx (x64)
  ※DEVELOPMENT KITの場合の手順は、別ページになってました。
• Bundler 1.11.2
• Jekyll 2.4.0

ツールのインストール手順

1. Rubyのインストール
   配布サイトにあるRubyInstallersのセットアップEXEをダウンロード。
   ダブルクリックしてガイドに従って進める。
   途中にある環境変数PATHへrubyコマンドへのパスを追加するチェックボックスをオンにする。
   なお試してませんが、このチェックボックスをオンにしなくても、スタートメニューに追加されるRubyコマンドプロンプトを実行しておけばよさそうです。
   私は任意のコマンドプロンプトで作業したいためオンにしました。
2. Ruby DEVELOPMENT KITのインストール
   Jekyllインストール手順に直接かかれてませんが、これを飛ばして進めると、Jekyllのインストール時に次のようなエラーが出るので必須だった模様です。
   
   Jekyllインストール時にDevelopment-Kitに関するエラーになる

   MS DOS

   Gem::InstallError: The 'RedCloth' native gem requires installed build tools. Please update your PATH to include build tools or download the DevKit from 'http://rubyinstaller.org/downloads' and follow the instructions at 'http://github.com/oneclick/rubyinstaller/wiki/Development-Kit'

   1 2 3 4 5

   Gem::InstallError: The 'RedCloth' native gem requires installed build tools.   Please update your PATH to include build tools or download the DevKit from 'http://rubyinstaller.org/downloads' and follow the instructions at 'http://github.com/oneclick/rubyinstaller/wiki/Development-Kit'

   
   同じく配布サイトにあるDEVELOPMENT KITのセットアップEXEをダウンロード。
   こちらは実行したディレクトリにフォルダがたくさんできるのでダウンロードしたディレクトリで実行するとびっくりします。
   また超重要ですが、展開したディレクトリは削除してはいけません。
   そのため、Rubyインストールディレクトリの中にRubyDevKitなどのディレクトリを作って展開。
   展開したら次のコマンドを実行
   
   Ruby

   cd RubyDevKit ruby dk.rb init ruby dk.rb install

   1 2 3

   cd RubyDevKit ruby dk.rb init ruby dk.rb install

   
   この直後に、RubyDevKitディレクトリを削除してしまったのがはまったポイントです。削除せずに進めましょう・・・。
3. Bundlerのインストール
   配布サイトにあるとおりにコマンドを実行。
   
   Ruby

   gem install bundler

   1	gem install bundler

4. Gemfileファイルの作成
   メモ帳等のテキストエディタで次の内容のファイルを作成。3行目のwdmはJekyll実行時に設定するように指示がありました。
   
   Vim

   source 'https://rubygems.org' gem 'github-pages' gem 'wdm', '>= 0.1.0' if Gem.win_platform?

   1 2 3

   source 'https://rubygems.org' gem 'github-pages' gem 'wdm', '>= 0.1.0' if Gem.win_platform?

5. Jekyllのインストール
   上記Gemfileを使ったインストールを実行。
   
   Ruby

   bundle install

   1	bundle install

Jekyllサイトのセットアップ

1. Gitリポジトリのクローン
   あらかじめGitHubへユーザ登録を済ましておき、次のようにチェックアウトします。
   
   MS DOS

   git clone https://github.com/ユーザ名/プロジェクト名.git ローカルディレクトリ名 cd ローカルディレクトリ名 git checkout gh-pages

   1 2 3

   git clone https://github.com/ユーザ名/プロジェクト名.git ローカルディレクトリ名 cd ローカルディレクトリ名 git checkout gh-pages

2. Jekyllのサイトディレクトリを作成
   特に気にせず指示通りに以下を実行。Jekyllは新しいディレクトリでないと新規作成できないようです。
   
   Ruby

   jekyll new テンポラリディレクトリ名 move テンポラリディレクトリ名\* . rmdir テンポラリディレクトリ名

   1 2 3

   jekyll new テンポラリディレクトリ名 move テンポラリディレクトリ名\* . rmdir テンポラリディレクトリ名

以上でJekyllのインストールとセットアップは完了です。
MarkDownで原稿作成、Jekyll serveでの動作確認など今のところ支障なく動作するようになりました。