The Diary of Aska

DocLife v0.01 release

PODやMarkdown形式のドキュメントをローカル環境で編集している際、HTMLに変換された際の表示を確認したくなる。

そんな時、こんなコマンドで確認出来れば良いのにと思って作ったモジュールです。

# Install
cpanm DocLife
# or (newest release)
cpanm https://github.com/s-aska/DocLife/tarball/master

# Run Pod Viewer
plackup -MDocLife::Pod -e 'DocLife::Pod->new( root => "./lib" )->to_app'

# Run Markdown Viewer
plackup -MDocLife::Markdown -e 'DocLife::Markdown->new( root => "./lib" )->to_app'

単にPODやMarkdownをHTMLに変換するだけでなく多少CSSを加えていますので、ワンライナーで使ってもそれなりに見るに耐えると思います。

また、トップディレクトリへのアクセスでファイルの一覧を表示します。

cpanやgithubに上げる前の確認だけでなく、社内レポジトリで上げておくのも良いと思います。必要なところには既にありそうなものですが。

このブログや私の個人的な備忘録もこのモジュールを元にして作られています、それらはgithubレポジトリのexampleに同梱している為、すぐに試す事が出来るでしょう。

Perl Moduleやその他オープンソースプロダクトのドキュメント作成に一役買えれば幸いです。

ネームスペースが重いので cpan に上げるかどうかは検討中です。

上げました。