読者です 読者をやめる 読者になる 読者になる

リポジトリビューアで Markdown ファイルを整形して表示する

id:tmtms:20100914:redmine のパッチで Redmineリポジトリビューアの「見る」で日本語で書かれたドキュメントもちゃんと表示されるようになりました。
が、Markdown 等の形式で書かれたファイルはソースではなく整形された形式で表示された方が便利です。ということで Markdown 形式のファイルを整形して表示するプラグインを作ってみました。
http://github.com/tmtm/redmine_markdown_extra_viewer

BlueFeather が必要です。

次のようにしてインストールできます。

% gem install bluefeather
% script/plugin install git://github.com/tmtm/redmine_markdown_extra_viewer.git

リポジトリ内の拡張子が .md または .markdown のファイルを「見る」で、整形された文書が表示されます。ソースを見たい場合は「ダウンロード」してください。

Markdown 形式でドキュメントを書いて Redmine 上で見たければリポジトリ内に置くのではなく Wiki に書けばいいじゃないか…という意見もあるかもしれませんが、ドキュメントをリポジトリに置くと次のようなメリットがあります。

  • 複数人で編集できる
  • 複数のドキュメントを同期して履歴管理できる
  • プログラムコードと同期してドキュメント管理できる

Markdown にしたのはソースを人間が見ても読みやすいと思ったからです。まあ個人的な好みですが。
デメリットはローカルで編集しながら表示がどのようになるかを確認できないってことですが、まあそこは RDoc と同じだし、各自頑張るということで… :-)