Java 6+ JRE がインストールされてて java コマンドが使用できる状態なら準備はおっけい。

Bashベースのプラットフォーム（Mac OSX、Unix、Linux、Cygwin、Solarisなど）の場合、http://sdkman.io/[SDKMAN] を使ってインストールすることもできます。最新の SDKMAN を準備しといてください。

準備ができたら以下のコマンドを入力すれば JBake の最新バージョンがインストールできます。

あなたが OS X を使用しているオシャレ野郎な場合、http://brew.sh/[Homebrew] を使ってインストールすることもできます。 Homebrew を準備した後に以下のコマンドを入力すれば JBake の最新バージョンがインストールできます。

最初にインストールに書いてある方法で JBake を準備します。 次に、コマンドプロンプトを開いて次のコマンドを打って、動作確認をします。

上手くインストールできていれば、以下のような文字が表示されます。

手っ取り早く始めたい場合、サンプルテンプレートを使ったサンプルプロジェクトを使用することが出来ます。 まず新しいディレクトリを作成して、その中に入ります。

次に以下のコマンドを打つと、プロジェクトの基本構造とサンプルテンプレートがディレクトリ内に生成されます。

コンテンツを追加したり、テンプレートをカスタマイズしたら次のコマンドでこんがり焼くことができます。

サーバーモードで JBake を実行すれば、こんがり焼いたプロジェクトがどのように見えるかすぐに確認できます。

ブラウザで http://localhost:8820 にアクセスすると、結果が確認できます。

こんな感じで、ステキな焦げ色のサイトがものの数分で焼きあがるっていう寸法ですよ！

bake コマンドはコンテンツとテンプレートを上手い具合に調理して、しっかり火の通ったWebサイトに仕上げます。 その方法は用途によっていくつか選ぶことが出来ます。

-b オプションの後ろに何も指定しない場合、現在の作業ディレクトリが bake 対象のコンテンツの位置と認識し、直下の output ディレクトリに調理結果を配置します。

<source>ディレクトリのみをパラメータに指定した場合、調理結果は<source>ディレクトリの直下に生成されます。

加えて<output>ディレクトリも指定すれば、すべてお好みの方法で料理することができます。

<source>ディレクトリと<output>ディレクトリの両方を指定する場合には、 -b オプションは省略可能です。

初期化コマンドは、指定したディレクトリにプロジェクトに必要になるディレクトリ構造と多くのサンプルコンテンツ、テンプレートを配置します。 その際には、テンプレートの記述言語としてどのテンプレートエンジンを使用するかを選ぶことができます。

-i オプションの後ろに何も指定しない場合、現在の作業ディレクトリ内に、 Freemarker をテンプレートエンジンとして利用するプロジェクトを生成します、。

初期化するディレクトリを指定したい場合には、パラメータとして追加します。

テンプレートエンジンを変更したい場合には -t オプションを使って指定します。

サーバーコマンドを利用すると、HTTP WEBサーバーが立ち上がり、生成されたサイトの見た目を確認することができます。 リリース前にサイトの内容をプレビューするのに便利です。

-s オプションを使用すると、JBake はサーバーモードで起動し、http://localhost:8820/ にアクセスすることによって生成されるサイトをプレビューすることができるようになります。 デフォルトでは output ディレクトリの内容が表示されます。

追加のパラメータを指定することによって、表示するディレクトリを変更することができます。

オプションコマンドは以下のように複数指定することもできます。

上記コマンドでは、JBake はサイトを生成した後にサーバーモードでも起動します。

Assets ディレクトリは、画像、CSSファイル、JavaScriptファイル等の静的ファイルを配置する場所です。 これらのファイルはなんの変換もされず、出力ディレクトリにコピーされます。 Assets ディレクトリ内の内容はそのままコピーされるため、好きなようにディレクトリ構造を作成しちゃってください。

Content ディレクトリは変換対象となるコンテンツを配置する場所です。このディレクトリ内のファイルは Bake (テンプレートによって処理) されて出力されます。 ディレクトリ内には自由にディレクトリ構造を作成することもできます。そのディレクトリ構造は Bake された処理結果にもそのまま適用されます。

JBake はコンテンツディレクトリ内のファイルをファイル拡張子によって判断して処理します。

Templates ディレクトリはテンプレートファイルの配置場所です。これらのファイルはContent ディレクトリ内のファイルと「結合」された状態で出力されます。 このディレクトリ内のファイルはTemplates ディレクトリ直下に配置されている必要があります。

ディレクトリ内のファイルは、ファイル拡張子によって処理に使われるテンプレートエンジンが決まります。

同じプロジェクト内で違うテンプレートエンジンを混在させることはやめておいたほうが良いです。 各テンプレートエンジンの詳細については、JBake が提供しているサンプルテンプレートと、それぞれのプロダクトのドキュメント ( Freemarker、 Groovy、 Thymeleaf、 Jade ) を参照してみてください。

プロジェクト固有の設定は、プロジェクトのルートディレクトリにある jbake.properties ファイルに記述します。 このファイルの記述内容によって JBake はプロジェクトの焼き加減を調整したりします。

メタデータヘッダには Content ファイルを処理するための基本的な設定内容を記述します。

素のHTMLや、各マークダウン記法によって記述されたファイルの先頭には以下のようなメタデータヘッダが 必須 です。

status と type のヘッダ項目は 必須 で、その他の項目はオプションです。 設定ファイル 内にデフォルトの status が記述されている場合には、status の項目は省略することができます。

date の項目を記述しない場合、該当ファイルの更新日が使われます。

AsciiDocで記述されたファイルの場合、メタデータヘッダはオプションになります。 メタデータは AsciiDoc の記法を使って以下のように定義します。

メタデータヘッダ記述より後のすべての内容は、コンテンツ本体としてテンプレートに処理されます。 Markdown記法、AsciiDoc記法によって記述されている場合にはHTMLに変換されます。

JBake のデフォルトテンプレートには、コンテンツファイルを必要としない、特別なページを出力するためのテンプレートファイルがいくつか準備されています。

これらのファイルを出力する必要がない場合、jbake.properties ファイルに以下のように記述することで、処理を制御することができます。

加えて、デフォルトテンプレートには、コンテンツを処理するための２つのテンプレートが定義されています。

いろいろな見た目のコンテンツを出力するために、独自のテンプレートを定義することもできます。

まず、以下のような記述を jbake.properties に加えます。

次に、テンプレートファイルを作成し、プロジェクトの 'templates' ディレクトリに配置します。 追加したテンプレートを利用する場合には、コンテンツファイルのメタデータヘッダに以下のように記述します。

HTML以外のファイルを出力するテンプレートを定義する場合には、 jbake.properties ファイルに以下のような記述を追加します。

これらのデータ値は、すべてのテンプレートで参照することができます。

jbake.properties ファイル内の記述を参照する場合には、データ項目名の . を _ に変換してください。 たとえば、 template.index.file=index.ftl を参照する場合には、 config.template_index_file と指定します。

テンプレート内では、一覧 ( Collection ) データをループで回して、各コンテンツ内の要素にアクセスすることができます。 ループのスコープ内では、content.title や、 content.body など、content.[value] という記述でコンテンツの各要素を参照します。

Page、Post または独自に定義したテンプレート内では、次のデータが定義されています。

content.title などのメタデータヘッダや、ファイルのBody要素である content.body など、全てのデータに対してアクセスが可能です。

またマップには以下の情報も含まれて居ます。

このテンプレートでは、ページングを実現するために必要となる変数を参照することができます。

これらの変数を利用すると、テンプレート内でページを前後するためのUIが提供できるようになります。

このテンプレートでは以下の追加データが定義されています。

jbake.properties ファイルには独自の設定を追加することも可能です。 サンプルプロジェクトにはサイトのホストURLを定義する site.host が記述されています。

この独自設定オプションは、フィードファイル用テンプレート内で以下のようにリンクの絶対URLを生成するために参照されています。

メインの JBake アーティファクトは以下の記述で Maven セントラルリポジトリから入手することができます。

Markdown コンテンツや Freemarker テンプレートエンジンなどをサポートするサードパーティーのライブラリは、 jbake-core のオプションライブラリとして定義されています。そのため、これらを使用する場合にはプロジェクトの依存関係を追加する必要があります。

Markdown コンテントをサポートするためには、以下の記述を追加します。

AsciiDoc コンテントをサポートするためには、以下の記述を追加します。

Freemarker テンプレートをサポートするためには、以下の記述を追加します。

Groovy テンプレートをサポートするためには、以下の記述を追加します。

Thymeleaf テンプレートをサポートするためには、以下の記述を追加します。

Jade テンプレートをサポートするためには、以下の記述を追加します。

JBake をJavaプログラムから起動する際にメインとなるのは Oven クラスになります。 このクラスのインスタンスを生成する際にいくつかの引数を渡し、 .bake() メソッドを実行します。

コマンドラインインターフェイス以外の全ての出力は、 LogBack を利用して行われています。そのため、クラスパス上の logback.xml を編集することによって制御することができます。 バイナリディストリビューションには、あらかじめ設定された logback.xml が含まれているので、参考にして下さい。

Maven から JBake を実行可能とするプラグインが利用可能です。

このプラグインは、以下の記述によって Maven セントラルリポジトリから取得することが出来ます。

このプラグインは Aldrin Leal によって開発されました。

Gradle の JBake プラグインもあります。

このプラグインは Cédric Champeau によって開発されました。

SBuild のプラグインもあります。

このプラグインは、以下の記述によって Maven セントラルリポジトリから取得することが出来ます。

このプラグインは Tobias Roeser によって開発されました。