タムタムの日記

READMEを書くときはMarkdown形式で書くと思うのですが、四六時中その記法で書いているわけでは無いので、なかなか覚えられないわけです。Rubyの場合はRDoc形式で書くのが普通なのかな？まぁWikiにしろ何にしろ似たような記法増えすぎだと思うのです。

わたしのようなゆとりには、プレビューしながら確認できるととても幸せになれます。とは言っても、ブラウザ上で入力なんてしたくないし、自分のお気に入りのエディタを使いたいわけです。

こちらの記事にあるツールを使っていたのですが、どうも自分の環境ではファイルを保存しなおすと、高確率でreadでこけるようで・・。

というわけで（上記ツールを参考にして）自分で作ってみました。

 

 

インストール、および実行方法は以下のようになります。

gem install rdoc-view
rdoc-view [-p port] [-o addr] [-t type] filename

filenameには確認したいREADMEファイルを指定します。RDoc形式とMarkdown形式に対応しており、ファイル名の拡張子(rdoc, md)で判断します。md形式の場合はgithubのAPIを叩きます。

http://localhost:4567/ にアクセスするとファイルの内容をリアルタイムで確認できます。WebSocketを使っており、ChromeとFirefoxでのみ動作確認をしています。IEは知らん。

ポート番号がかちあう場合は -p オプションでポート番号を指定できます。また拡張子が無い場合やrdoc, md以外の拡張子の場合はRDoc形式でレンダリングするため、明示的に形式を指定する場合は -t オプションを使います(例: -t rdoc, -t md)。

以下が実際のブラウザの画面です。WebSocketが切断した場合(CLOSED)は5秒間隔で再接続を試みます。また、サーバからはKeepAlive代わりにControlFrameのPingRequestを5秒間隔で送信しています。
 

 

これでREADMEを書くのが捗りますね！
と、言いつつrdoc-viewのREADMEが簡素な件について（＝△＝；）

ソースはgithubに置いてあります。
https://github.com/tamtam180/rdoc-view