retter 0.1.3 → 0.2.0

data/.gitignore

@@ -8,7 +8,6 @@ tmp/*
 lib/generator/skel/.gitignore
 lib/generator/skel/.preview.html
 lib/generator/skel/retters/*.md
-lib/generator/skel/tmp/*
 lib/generator/skel/entries.*
 lib/generator/skel/entries/*.html
 lib/generator/skel/vendor

data/.rspec

@@ -1 +1,2 @@
 --format Fuubar
+--color

data/.travis.yml

@@ -1,3 +1,2 @@
 rvm:
-  - '1.9.2-p290'
-  - '1.9.3-p0'
+  - '1.9.3-p125'

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# 0.2.0
+
+## Features
+
+Pygments Support.
+
+Pygments syntax highlight is now available.
+To use, add a following line to Retterfile.
+
+```ruby
+renderer Retter::Renderers::PygmentsRenderer
+```
+
+## Improves
+
+* Improved boot overhead of all command.
+* Improved wait time for rebind (bind) command by cache.
+
+# 0.0.1
+
+It's first release.

data/README.md

@@ -1,242 +1,184 @@
-# 注意
+# RETTER - Flyweight diary workflow. [![Build Status](https://secure.travis-ci.org/hibariya/retter.png?branch=master)](http://travis-ci.org/hibariya/retter)
 
-0.1.0 以降、`layouts/`ファイル以下に追加と変更があります。
-以下のコマンドで`layouts/`以下のファイルを上書きしてください。
-
-~~~~
-  retter gen $RETTER_HOME
-~~~~
-
-# RETTER (レッター) Flyweight diary workflow.
-
-手軽さを追求した記事作成ツール。以下のような特徴があります。
+手軽さを追求した記事作成ツール。
 
 * CLIでの操作を前提としています
-* どこ（cwd）にいてもすぐに記事を編集できます（Markdown）
+* どこ（cwd）にいてもすぐに記事をMarkdownで編集できます
 * オフラインで簡単にプレビューできます
-* だいたいどんなサーバ上でも動作します（Heroku, GitHub Pages, Dropbox などで、静的HTMLまたはRackアプリとして）
+* だいたいどこでも動作します（Heroku, GitHub Pages, Dropbox などで、静的HTMLまたはRackアプリとして）
 * RSSフィードを吐きます
-* トラックバック、**コメント**などの機能は外部のサービスを使用できます
+* トラックバック、**コメント**などの機能は外部のサービスを使う必要があります
 * コールバックを設定することでさらに手数を減らすことができます
 
-# インストール - Installation
+# Quick Start
 
 *ruby-1.9.2* or later is required.
 
+**Install:**
+
 ~~~~
   gem install retter
 ~~~~
 
-# 使い方 - Usage
-
-## 新規サイト生成 - New site
-
-`retter new`で新しいサイトのひな形を生成し、依存ライブラリをインストールし、gitリポジトリを初期化します。
+**Generate a new site:**
 
 ~~~~
   $ retter new my_sweet_diary
 ~~~~
 
-生成するファイルはHAMLテンプレート、設定ファイル、デフォルトのCSS、Rackアプリ用の設定などです。
-
-## 初期設定 - Settings
-
-### $EDITOR
-
-**retter requires `$EDITOR` variable.**
-
-Retterで記事を編集する際には任意のエディタが起動します。そのためには`$EDITOR`環境変数が設定されている必要があります。
-大抵の場合は設定されていると思いますが、もし設定されていなければ`~/.bash_profile`や`~/.zshenv`などに追記する必要があります。
+**Quick settings:**
 
 ~~~~
-  $ echo "export EDITOR=vim" >> ~/.bash_profile
-  $ . ~/.bash_profile
+  $ export EDITOR=vim
+  $ export RETTER_HOME=`pwd`/my_sweet_diary
 ~~~~
 
-### $RETTER_HOME
-
-ファイルシステム上のどこに居ても`retter`コマンドを使って編集から公開まで行えるよう、 事前に`$RETTER_HOME`環境変数を設定します。
-
-You can use `retter` command anywhere, If you set `$RETTER_HOME` variable.
-
-~~~~
-  $ echo "export RETTER_HOME=/path/to/my_sweet_diary" >> ~/.bash_profile
-  $ . ~/.bash_profile
-~~~~
-
-作業ディレクトリにRetterfileがある場合は、そのディレクトリが`$RETTER_HOME`に指定されているものとして動作します。
-
-## 記事を書く - Write an entry
-
-`retter`コマンドは設定されているエディタを起動します。今のところMarkdown形式で記事を書くことができます。
-
-`retter` opens `$EDITOR`. Write an article with Markdown.
+**Writing article:**
 
 ~~~~
   $ retter
 ~~~~
 
-記事をひと通り書き終えたり確認したくなったら、エディタの機能で記事を保存して終了してください。
-保存された記事は、その段階ではまだ下書きの状態です。
-
-## プレビュー - Preview
-
-下書きの記事を確認するには`preview`サブコマンドを使います（デフォルトブラウザが起動します）。
+`retter` opens `$EDITOR`. Write an article with Markdown.
 
-`preview` opens the draft article by your default browser.
+**Preview:**
 
 ~~~~
   $ retter preview
 ~~~~
 
-気に入らない箇所を見つけたらページを閉じて、また`retter`コマンドで記事を編集します。
-満足のいく文章が出来上がるまで編集とプレビューを繰り返しましょう。
-
-
-## 記事の生成 - Bind
-
-下書きが完成したら、記事をそのサイトのページとして生成します。
-`bind`, `rebind` は下書きの記事をその日の記事として保存し、すべてのHTMLを再生成します。
+`preview` opens the draft article by your default browser.
 
-`bind` and `rebind` binds the draft article. And re-generates actual html web pages. All html pages will be overwritten.
+**Generate HTML:**
 
 ~~~~
-  $ retter bind
+  $ retter rebind
 ~~~~
 
-## サイト全体の確認 - Browse Offline
-
-生成されるすべてのページは静的HTMLですから、オフラインでも自分のマシンで全体的な見栄えを確認できます。
-`open`サブコマンドはデフォルトブラウザを起動してサイトのトップページを開きます。
+`bind` and `rebind` binds the draft article. And re-generates actual html web pages. All html pages will be overwritten.
 
-`open` sub-command opens your (static) website by your default browser.
+**Browse offline:**
 
 ~~~~
   $ retter open
 ~~~~
 
-デプロイ先のサーバではRackアプリとして起動しているということであれば、rackupで確認しましょう。
+`open` sub-command opens your (static) website by your default browser.
+
+**Show Articles list:**
 
 ~~~~
-  $ retter home # `home` opens a new shell in $RETTER_HOME.
-  (retter) bundle exec rackup
+  $ retter list
+  [e0] 2011-11-09
+    my sweet article title
 ~~~~
 
-## 記事の公開 - Publish
-
-記事をインターネット上に公開するには、必要なすべてのファイルを git リポジトリにコミットしリモートサーバに push、または単純にファイルをアップロードします。
+**Re-writing an article:**
 
-To publish, use the git command. Or, upload the file to your server.
+~~~~
+  $ retter edit e0
+  ... abbr ...
+  $ retter preview e0
+~~~~
 
-### Basic flow
+**How to Deploy**
 
-最も原始的な方法は、gitコマンドを直接使う方法です。
+examle:
 
 ~~~~
   $ cd $RETTER_HOME
   $ git add .
-  $ git commit -m 'commit message'
-  $ git push [remote] [branch]     # heroku, github pages, etc..
+  $ git commit -m 'Entry written'
+  $ git push [your_git_remote] master
 ~~~~
 
-### Using shortcut commands
+To publish, use the git command. Or, upload the file to your server.
 
-いくつかのショートカットを使い、コミットメッセージを書くことを省略したりすることができます。
+# Environment variables
 
-~~~~
-  $ retter commit # Shortcut of `git add . ; git commit -m 'Retter commit'`
-  $ retter home   # Open a new shell at $RETTER_HOME
-  (retter) git push [remote] [branch] # heroku, github pages, etc..
-~~~~
-
-後述するコールバックを設定しておくことで、さらに手数を減らすことも可能です。
+**Important**
 
-## 特定の日付の記事を編集する - Edit entry (specific date).
+retter requires `$EDITOR` variable.
 
-昨日、明日、過去や未来の日付を指定して記事を編集・プレビューするには、 `--date` オプションを用います。
+## $RETTER_HOME
 
-`--date` option is available in `edit` `preview` sub-command.
+You can use `retter` command anywhere, If you set `$RETTER_HOME` variable.
 
 ~~~~
-  retter --date 20110101         # 編集
-  retter preview --date 20110101 # プレビュー
+  $ echo "export RETTER_HOME=/path/to/my_sweet_diary" >> ~/.bash_profile
+  $ . ~/.bash_profile
 ~~~~
 
-サブコマンドを明示する場合は、日付の指定は引数のように指定することもできます（`--date`が不要になります）。
+You have to cd to the directory, If you don't set `$RETTER_HOME` variable.
 
 ~~~~
-  retter edit 20110101
-  retter preview 20110101
+  $ cd path/to/my_sweet_diary
+  $ retter
 ~~~~
 
-日付は相対的に指定することができます。以下のような形式をサポートします。
+# Using shortcuts
 
 ~~~~
-  retter edit yesterday    # 昨日
-  retter edit today        # 今日
-  retter edit tommorow     # 明日
-
-  retter edit '3 days ago' # 3日前
-  retter edit 3.days.ago   # 3日前
-  retter edit 3.days.since # 3日後
-  retter edit 1.week.ago   # 1週間前
-  retter edit 3.weeks.ago  # 3週間前
-  retter edit 3.months.ago # 3カ月前
-  retter edit 3.years.ago  # 3年前
+  $ retter commit # Shortcut of `git add . ; git commit -m 'Retter commit'`
+  $ retter home   # Open a new shell at $RETTER_HOME
+  (retter) git push [remote] [branch] # heroku, github pages, etc..
 ~~~~
 
-## 特定のファイルを編集する - Edit entry (specific file).
+# Command options
 
-記事の編集・プレビューにはファイル名での指定も可能です。
+Date is specify-able in `edit` `preview` sub-command.
 
 ~~~~
-  retter edit today.md
-  retter edit 20110101.md
-  retter preview 20110101.md
+  $ retter edit 20110101    # edit
+  $ retter preview 20110101 # preview
 ~~~~
 
-## 記事の一覧を出力する - Browse entries
-
-これまでに書いた記事の一覧を出力することができます。すべての一覧を出力するため、`less`や`lv`、`grep`などで適宜フィルタしてください。
+Relative date is available too.
 
 ~~~~
-  retter list
-  [e0] 2011-10-12
-    記事ごとにPermlinkがつくようにした, retter 0.1.0
+  $ retter edit yesterday
+  $ retter edit today
+  $ retter edit tommorow
 
-  [e1] 2011-10-10
-    Rubyのトップレベルについて整理する
-
-  [e2] 2011-10-03
-    モジュール関数がprivateな理由
-
-  [e3] 2011-09-19
-    スタイルシートを追加してテーマを変えられるようにした
+  $ retter edit '3 days ago'
+  $ retter edit 3.days.ago
+  $ retter edit 3.days.since
+  $ retter edit 1.week.ago
+  $ retter edit 3.weeks.ago
+  $ retter edit 3.months.ago
+  $ retter edit 3.years.ago
 ~~~~
 
-日付の左側に表示されている文字列は、編集やプレビューの際の記事の指定するキーワードとして使うことができます。
+And file name.
 
 ~~~~
-  retter edit e3
-  retter preview e3
+  $ retter edit today.md
+  $ retter edit 20110101.md
+  $ retter preview 20110101.md
 ~~~~
 
-## コールバック - Callbacks
-
-コールバックはいくつかのサブコマンド（edit bind rebind commit）の実行直後に自動的に実行されます。
-コールバックを定義しておくことで、手数の多い割に代わり映えのしない作業を自動化することができます。
+# Callbacks
 
-Callback is enabled in `edit`, `bind`, `rebind` and `commit` sub-command.
+Some command (edit bind rebind commit) will call callback if you defined callbacks.
 
-### Syntax
+In Retterfile:
 
-~~~~ruby
+~~~~
   after [command], [invoke command or proc]
 ~~~~
 
-### HTMLの生成時、デプロイまでの作業を自動化する - Auto deploying
+## Example1: Auto preview
 
-以下のような内容を Retterfile に記述しておくことで、rebind または bind が実行されると即座に公開までの処理も実行されます。
+In Retterfile:
+
+~~~~ruby
+  after :edit do
+    ident = ARGV.pop || 'today'
+    preview ident if yes?("Preview now? [yes/no]")
+  end
+~~~~
+
+## Example2: Auto deploying
 
 In Retterfile:
 
@@ -249,33 +191,19 @@ In Retterfile:
   end
 ~~~~
 
-もし毎回デプロイするのが煩わしい場合は、`--silent`オプションを付けることでコールバックを回避できます。
-その場合は`retter rebind`ではなく`retter rebind --silent`を実行することになります。
+## Skipping callback
 
-`--silent` option skip the callback.
+`--silent` option skips those callback.
 
-### エディタを終了したとき即座にプレビューする - Auto preview
+## Run callback
 
-記事を編集しエディタを終了したあとブラウザでプレビューしたい場合は、`edit`へのコールバックを設定できます。
-
-~~~~ruby
-  after :edit do
-    preview ARGV.pop if yes?("Preview now? [yes/no]")
-  end
-~~~~
-
-もしもコールバックを毎回実行したくない場合、`--silent`を指定する以外に、上記のように確認プロンプトを表示させるという方法もあります。
-
-### コールバック呼出し
-
-コマンド実行後にコールバックだけを再度実行したい場面では、`callback`サブコマンドを使用できます。
+`callback` sub-command runs only callback proccess.
 
 ~~~~
   $ retter callback --after edit
 ~~~~
 
-## コメントシステム（DISQUS）の導入 - Install DISQUS
-
+## Install DISQUS (Comment tool)
 
 ### Prepare
 
@@ -302,10 +230,19 @@ in layouts/article.html.haml
 -# abbrev
 ~~~~
 
-## 組込みテーマ - Pre-installed themes
+# Code Highlight
+
+Pygments is available.
+To use, add a following line to Retterfile.
+
+```ruby
+renderer Retter::Renderers::PygmentsRenderer
+```
 
-スタイルシートを変更することでテーマを変更できます。HTMLのヘッダを変更するには `layouts/retter.html.haml` を編集します。
-スタイルシートの指定を変更し、`retter rebind`コマンドを実行するとすべてのページが更新されます。
+## Built-in themes
+
+Retter has some themes.
+You can switch the theme by replacing stylesheet.
 
 ### Default
 
@@ -323,25 +260,19 @@ in layouts/article.html.haml
 
 ![Orange](http://hibariya.github.com/images/theme_samples/retter_orange.jpg)
 
-## HTMLの修正 - HTML Layout
+## HTML Layout
 
-HTMLのレイアウト自体を変更するには`layouts/`ディレクトリ以下のHAMLファイルを修正します。
-これらのファイルを変更したとしても、`retter rebind`コマンドを実行するまでは反映されません。
+To customize layout, edit following files.
 
 ~~~~
 layouts
-  |-- article.html.haml
-  |-- entries.html.haml
-  |-- entry.html.haml
-  |-- index.html.haml
-  |-- profile.html.haml
-  `-- retter.html.haml
-~~~~
-
-`retter.html.haml`はHTML宣言を含めた全体のHTMLが含まれています。
-`entry.html.haml`を変更することで日別のページのレイアウトを変更することができます。
-`article.html.haml`を変更することで個々の記事のレイアウトを変更することができます。
-その他のファイルは実際のURLと名前が対応しています。
+  |-- article.html.haml # Article page
+  |-- entries.html.haml # Entries list page
+  |-- entry.html.haml   # Entry (by day) page
+  |-- index.html.haml   # Front page
+  |-- profile.html.haml # Profile page
+  `-- retter.html.haml  # Basic layout
+~~~~
 
 # LICENSE