Skip to content

00_md2EPUBについて

shunito edited this page Apr 17, 2012 · 1 revision

md2EPUBについて

md2EPUBはRubyで作られたEPUBジェネレータです。 markdown形式(.md)とtextile形式(.textile)のファイルをEPUBにします。 ネット上の画像が含まれる場合は、取得して一緒にパッケージします。

動作環境

  • Ruby 1.9.3でテストしています
  • markdown形式をXHTMLに変換するためにredcarpetを利用しています。
  • textile形式をXHTMLに変換するためにRedClothを利用しています。

インストール方法

現在のところgem化してませんので、githubより普通にファイルをダウンロードして任意の場所においてください。 ZIPファイル(Github master) カスタマイズしたいようであれば、git cloneかforkするのがよろしいかと。

簡単な使い方

以下をディレクトリにまとめて入れてください。

  • markdown形式のファイル(複数可)
  • textile形式のファイル(複数可)
  • epub.yaml(mdfiles内にサンプルあり)

ruby md2epub.rb [directory] で指定したディレクトリにEPUBを生成します。

EPUB内での並びはファイル名でソートされます。 各ページのタイトルは、最初の「=」から自動で設定されますが、見つからない場合はファイル名をタイトルとします。

設定など

  • EPUBのメタデータ設定は、epub.yamlで(一部)調整できますので、不足の場合は下記のカスタマイズで調整してください。
  • markdownが常に正しくValidなXHTMLに変換されるとは限りません。特に生で埋め込まれているHTMLなど問題になりやすいので、問題があればmarkdown側を調整してください。
  • markdown内で画像を利用したい場合は、同じディレクトリ内に「images」というディレクトリを作成して設置してください。現在のところ「images」固定ですが、一緒にパッケージします。