ゆーすけべー日記

天然パーマです。

Yomico。Markdownを快適に閲覧するために

2012-02-22 Perl Yomico

構造化された文章をプレーンテキストで書くためにMarkdown形式を使っているというお話を以前しました。

上記の記事でも触れているのですが、Yomico（よみこ）というPerl製のMarkdownビューアーを作りつつ使っていて、 結構いい感じなので紹介いたします。 お気づきの方もいるかも知れませんが、YomicoというネーミングはTV、OVAアニメや小説などで展開している 「R.O.D -READ OR DIE-」の登場人物である「読子・リードマン」に由来しています。 この読子。神保町に本を置くだけのためのビルをまるごと借りるなど生粋の読書好き＝ビブリオマニアなのです。 理想として、このYomicoを使って読子にMarkdownのテキストを快適にガンガン読んでもらいたいなー なんて思って名付けました。

R.O.D-READ OR DIE- 第1巻 [DVD]
R.O.D-READ OR DIE- 第1巻 [DVD]
posted with amazlet at 12.02.22
SME・ビジュアルワークス (2001-05-23)
売り上げランキング: 37562
Amazon.co.jp で詳細を見る


メルマガやこのBlogの記事も含めてMarkdownの文章を書く機会が 急に多くなったんですが、そのMarkdown書式のテキストファイルをHTMLに変換しつつブラウザでサクッと 見たいなっていうのが、Yomicoを作っている動機です。 Mac OSXだとMarkdownNoteというソフトがあって、 それを使えば編集とプレビューの2ペインを同時に見ることができて同じような目的を果たすことができるのですが、 なんとなく「編集はBywordっていう他のソフトを使いたいなぁ」とか、 「編集とプレビューは同時に見えない方が逆にいいんじゃね？」とか思って自作した次第です。

開発はgithubで公開しつつ行っています。

久しぶりに人に見せられて、頻繁にアップデートしたいと思うソフトです。まぁとはいえPerlのコード部分は200行弱の 短いものなんですけどねぇ。

Yomicoをインストールすると以下のことができます。

  • 「yomico」コマンドを使うことができる
  • ターミナルからMarkdownファイルを指定してyomicoコマンドを実行するとブラウザで整形したMarkdownが見られる
  • ファイル単体だけでなくてフォルダも指定可能
  • 起動ポートはデフォルトで5000だけど変更できる
  • CSS Frameworkに「inuitcss」を使っており文字が読みやすい
  • Faviconもちゃんと設定したぉ

以下がこの記事自体を書きながらプレビューしている様子のスクリーンショットです。

Yomicoスクリーンショット

インストールは「cpanm」というコマンドを入れて、ターミナルからこんな感じで行います。

$ git clone git://github.com/yusukebe/Yomico.git
$ cd Yomico 
$ cpanm .

うまく入れば、「yomico」コマンドを使うことができるので、 ファイルを指定したりディレクトリを指定したりして実行してください。

$ cd notes
$ yomico README.mkdn

とか、カレント指定しつつポートも任意のものにする場合は

$ cd notes
$ yomico . -p 5001

という具合です。デフォルトの場合は「http://localhost:5000」にお使いのブラウザでアクセスすると整形したMarkdownもしくはファイル一覧を見ることができます。

現状の機能だけでも数週間使ってて大きな不満はないのですが、以下の点が今のところのTODOとして挙げられます。

  • 自分でCSSを指定できるカスタムCSS機能
  • ディレクトリ一覧などでオシャレなアイコンを使う
  • pre codeで囲まれたところをシンタックスハイライトしたい
  • ナビゲーションバーを付ける？
  • 文字数カウンターが地味に欲しい

もし、Yomicoを使ってみて「こんな機能欲しい！」「ここを改善して欲しい！」という要望があれば、 教えてもらえるか、githubでごにょごにょしてもらえると嬉しいです！以上、開発途中のYomicoの紹介でしたー。