PHP + Smarty製のデザイナ向け静的サイトジェネレーター。S3やGitHub Pagesなど、静的コンテンツしか扱えないホスティング環境でのサイト制作に便利です。
PHP CSS JavaScript CoffeeScript
Clone or download

README.md

Phest v.0.10.0

Phest (フェスト) はPHPでできた、デザイナ向けの静的サイトジェネレーターです。 (Phest = PHP Easy Static Site Generator)

静的サイトジェネレーターとは、テンプレートなどプログラム的な処理を実行し、HTMLファイルとして書き出すツールのことです。 Amazon S3でのホスティングやGitHub Pagesなど、静的ページしか使えないような環境向けのサイト作りに便利です。 テンプレートエンジンにはSmartyを採用。テンプレートファイルのインクルードや各種条件文などを柔軟に使用できます。

Phestはクラウド型ビジネスチャットツール「チャットワーク」を開発するChatWork社が開発しています。 ChatWork社内で実際にサイト制作に使用しているツールであるため、随時継続的なバージョンアップが行われています。

詳しくは、公開時のブログ記事を参照してください。

特徴

一般的な静的サイトジェネレータはプログラマ向けで、黒い画面(ターミナル)によるコマンド操作が必須です。 PhestはPHPさえ動けば、ブラウザによるGUI操作が可能でターミナルによるコマンド操作は必要ありません。 ファイルの自動更新検知もコマンドを実行する必要はなく、ブラウザ側から実行でき、更新をブラウザのデスクトップ通知でリアルタイムに通知します。 (※デスクトップ通知は対応しているブラウザのみ。Chrome/Firefox/Safari/Opera など)

Smartyの {include file=""}{if} {foreach} をはじめとした強力で柔軟なテンプレート構文が使用できます。 共通ヘッダやフッタなどを簡単に記述可能です。 index.tpl をファイル作成すると、index.html として生成されるイメージです。(フォルダ構造も自由に作成可能)

静的ファイルの書き出しにともなって、LESS/SCSS/CoffeScriptなどのコンパイル、圧縮処理(minify)を実行できます。 JavaScriptファイルは自動で構文チェックが行われ、セミコロン忘れ、オブジェクト要素の最後のカンマなどを指摘してくれます。 なお、圧縮処理は時間がかかるため本番環境用ビルドでのみ実行されます。

簡易なデータ記述言語であるYAMLで変数を定義することができます。 ベースレイアウトを記述したテンプレートの、<title> タグの中身をページごとに変更したり、 フォルダ階層ごとにレイアウトを変えたり、配列を定義してSmartyの {foreach} で回して一括展開することも可能です。

ページ一覧を記述した検索エンジン用のsitemap.xmlを自動生成します。 また、sitemap.xmlのパスを記述したrobots.txtも自動生成します。

ビルドしたファイルをAmazon S3の特定バケットに一括デプロイ(リリース)できる仕組みがあります。 S3側にアップされていて、ローカルにないファイルはS3側から自動で削除するなどファイルの同期も可能です。

ローカル環境時はドメインをlocalhostにして、本番用にはドメインを本番サーバーにしたバージョンで生成など、 環境に応じたファイル生成が柔軟に可能。watch機能によりファイルの変更を検知して自動でビルドを実行することもできます。

encodeオプションでJISコードに文字コード変換して生成させることもできます。

インストール

PHP5.3以上がインストールされている必要があります。 WindowsではXAMPP、MacではMAMPが簡単にインストールできるのでオススメです。 LinuxでもPHPが動けば基本動作しますが、JavaScriptの構文チェックは動作しませんのでご注意ください。(今後対応予定) また、ツール内部でGoogle Closure Compilerを実行するためJavaの実行環境が必要です。

PHPが稼働するドキュメントルート以下(通常 htdocs/www/public_html/ など)に、リポジトリ内のデータをコピーするだけでokです。

フォルダ構成は

  • phest/ (ビルドツール)
  • docs/ (ドキュメント)
  • sites/ (作成するサイトデータ)

となっています。

phest/ をブラウザから開くとビルドツールが表示されます。

docs/ をブラウザから開くと、Phestの使い方をまとめたドキュメントを表示できます。

※コピーするフォルダは phest/ だけでも問題ありません。 リポジトリにコミットされている sites/ にはあらかじめ参考となるサンプルのサイトデータが設置されていますが、不要であれば削除してください。

LICENSE

Licensed under MIT, see LICENSE