git-gendoc.usage.texttile

h1. Git-Gendoc使い方

h2. 動作確認済みの環境
 * Windows7
 * RubyInstaller for Windows ruby 1.9.3-p194
 * rubygems
 * GitBash

h2. 動作環境を構築する

1. RubyInstaller for WindowsでRuby1.9.3をインストール
   http://rubyforge.org/frs/download.php/76054/rubyinstaller-1.9.3-p194.exe
2. Gemのアップデートを行う
   gem update --system
3. GitBashをインストール
   このとき echo $LANG で ja_JP.UTF-8 が帰ってこない場合は、.bashrcなどで
   export LANG=ja_JP.UTF-8を設定する

h2. Git-Gendocをセットアップする

1. Git-Gendocのgitリポジトリをcloneしてくる
   git clone git@git.istyle.local:platform-api-ifdoc.git
2. cloneしたリポジトリの lib/ ディレクトリへ移動
   cd platform-api-ifdoc/lib/
3. Bundlerから必要なライブラリをインストールする
   bundle install
4. Git-Gendocのsetupコマンドを実行し、フックスクリプトとローカルブランチを作成する
   ./git-gendoc setup

h2. Git-Gendocでドキュメントを生成する

h3. Git-Gendocのディレクトリ構成

<pre>
  base/ -- 生成前ディレクトリ (*.textile[ドキュメント]/vars.yaml[ディレクトリ毎の共通値設定ファイル])
  html/ -- 生成後ディレクトリ (*.html)
  lib/  -- スクリプト格納ディレクトリ (git-gendoc[コマンド本体]/rule.rb[変換過程を定義するDSLファイル])
  tmp/  -- キャッシュが生成されるディレクトリ (リポジトリには含まれない)
  template/ -- ドキュメントのテンプレートを格納するディレクトリ (*.erb[テンプレートファイル])
</pre>

h3. ドキュメントを生成する

Git-Gendocでドキュメントを生成するには以下の方法があります。

 1. base/又はtemplate/ディレクトリ以下を変更して、sourceブランチにコミットを行う
 2. ./git-gendoc generate
 3. ./git-gendoc update

h3. スタイルを適用する

スタイルを適用するには、htmlディレクトリにcssファイルを含め、テンプレートから参照します。
この時、ファイルごとに渡される @to_root変数 (htmlディレクトリまでの相対バス)を利用して参照します。