Hello Ratpack
Groovy製のドキュメンテーションツールGaidenを使って作成されたRatpackの入門、チュートリアルです。
生成されたチュートリアルはコチラで確認できます。
ビルド方法
このリポジトリをcloneして、ローカルで編集することが出来ます。
準備
そのためには、Gaiden1.1以降が必要となります。
Gaidenを利用する方法は以下の2パターンがあります。
gaidenwの利用
Gaidenをインストールしなくても、このリポジトリをcloneした後にリポジトリ内で./gaidenw buildを実行すればMarkdownをHTMLへビルド可能です。
自動的にGaiden1.1がダウンロードされ、gaidenwからそのGaidenが利用されるようになります。
なお、GaidenはGroovyを利用しますので、事前にGroovyをインストールしておいてください。
gaidenをインストールして利用
SDKMANなどのツールを利用して、Gaidenが動作する環境を用意して下さい。
SDKMAMの場合は、
sdk install gaiden
だけでOKです。
なお、Gaidenを動作させるためにはJavaとGroovyも必要となります。
もしこの2つがインストールされていない場合は、共にSDKMANなどでインストールしておいて下さい。
最終的に、gaiden -vをコマンドラインから実行して、以下のような情報が出力されれば準備完了です。
[koji:sample]$ gaiden -v
_ _
(_) | |
__ _ __ _ _ __| | ___ _ __
/ _` |/ _` | |/ _` |/ _ \ '_ \
| (_| | (_| | | (_| | __/ | | |
\__, |\__,_|_|\__,_|\___|_| |_|
__/ |
|___/
Version : 1.1
Revision : 91ef3820725d47a625883393caa616f26368adfd
Build date : 2016-06-06 11:21:37.196+0900
OS : Linux 3.13.0-24-generic
JVM : 1.8.0_111
Groovy : 2.3.6
リポジトリのクローン
適当なディレクトリで、git clone git@github.com:koji-k/ratpack-tutorial.gitを実行して下さい。
すると、ratpack-tutorialというディレクトリ名で、リポジトリがクローンされます。
[koji:sample]$ git clone git@github.com:koji-k/ratpack-tutorial.git
Cloning into 'ratpack-tutorial'...
remote: Counting objects: 143, done.
remote: Total 143 (delta 0), reused 0 (delta 0), pack-reused 143
Receiving objects: 100% (143/143), 642.52 KiB | 1016.00 KiB/s, done.
Resolving deltas: 100% (58/58), done.
Checking connectivity... done.
[koji:sample]$ ls
ratpack-tutorial
これで、Markdownファイルを修正することが出来ます。
もしMarkdownファイルを新規作成した場合は、そのファイル名をpages.groovyに追記して下さい。
gaiden build(gaidenをインストールしていないのであればgaidenw build)を実行すると、Markdownが全てHTMLにコンバートされて、docs/ディレクトリ配下に出力されます。
docs配下にあるHTMLファイルをブラウザで開くことで、最終的な結果を確認することが出来ます。
注意：docsディレクトリにはHTMLが保存されますので、docsディレクトリにはMarkdownを保存しないようにして下さい。
なお、gaiden watchを実行しておけば、ファイルを追加したり編集したタイミングで自動的にgaiden buildが実行されるようになるのでお勧めです。
Gaiden自体の詳細な使い方はGaideの公式サイトを参照して下さい。