grunt-mdeb

mach3/grunt-mdeb @ GitHub
Grunt task to publish markdown docs as EPUB 3.0 book.

Markdown書類とJSONの設定ファイルからEPUBデータを作成します。 ナビゲーションドキュメント（論理目次＋視覚目次）はMarkdownを元に出力されるXHTMLから抽出されて自動的に生成されます。 名前の「mdeb」は「Markdown to eBook」の略です。

動作環境

タスクの中でシェルコマンドを叩いている箇所があるので、 bash等が動く環境でないと動作しません。 Mac OSX や Linux なら問題ありませんが、 Windowsの場合は Git CUI（MinGW）や cygwin 環境で使用する必要があります。 Git CUI は msysgit で Git 環境を導入していれば同梱されているのでお勧めです。

• Git for Windows
• MinGW | Minimalist GNU for Windows（Git CUIの中身です）
• Cygwin

デモ兼ドキュメント

ドキュメントは grunt-mdeb のリポジトリの「demo」の中に document.epub として保存されています。 これは実際に mdeb タスクで生成された EPUB データです。 変換される前の Markdown は demo/src に、EPUBデータにコンパイルされる前の XHTML データは demo/dest/tmp に格納されています。

• demo/src （Markdownデータ）
• demo/dest/tmp （XHTMLデータ）

基本的な使い方

1. インストール

npm でタスクをインストールします。

$ npm install grunt-mdeb

2. タスクの設定

Gruntfile.js で “grunt-mdeb” を読み込み、”mdeb” タスクを設定します。

grunt.loadNpmTasks("grunt-mdeb");

grunt.initConfig({
    mdeb: {
        dist: {
            options: {},
            src: "src",
            dest: "dest"
        }
    }
});

src と dest は必須項目で、それぞれ元データと出力データの格納ディレクトリを指定します。 options は任意でオプションを設定してください。

3. データ構成

src ディレクトリの中に元データを格納していきますが、次のような構成にします。 （各ディレクトリの名前は先述のオプションで変更する事ができます）

src/
├ assets/
├ data/
│ ├ cover.md
│ ├ 01.md
│ ├ 02.md
│ └ ...
└ publish.json

data ディレクトリにはコンテンツの元になる Markdown 書類を格納します。 assets ディレクトリにはスタイルシートや画像などの依存ファイルを格納します。 assets ディレクトリの中身は全て複製されて EPUB データに同梱されます。

4. publish.json

publish.json には、タイトルや著者名をはじめ、EPUBデータを構成する為の情報を全て記述します。

{
    "meta": {
        "name": "document",
        "title": "My First Book",
        "author": "mach3",
        ...
    },
    "assets": {
        "coverImage": "assets/img/cover.jpg",
        "commonStyle": "assets/css/common.css",
        ...
    },
    "items": [
        "data/cover.md",
        "data/01.md",
        "data/02.md"
        ...
    ]
}

中のデータは３つのセクションにわかれています。

• meta
  
  書籍の基本的な情報を格納する
• assets
  
  画像やスタイルシート等の情報を格納する
• items
  
  コンテンツドキュメントの元となる Markdown ドキュメントを列挙する

items の一番最初のドキュメントは表紙ページとして扱われる点にご注意ください。 項目のさらなる詳細やサンプルは ドキュメント に記してあります。

5. コンパイルする

mdeb タスクを実行して EPUB ファイルを生成します。

$ grunt mdeb

コンパイルに成功すると、dest ディレクトリの中に生成した EPUB データと、EPUB に固める直前のデータが格納されています。

dest/
├ tmp/
│ ├ OEBPS/
│ ├ META-INF/
│ └ mimetype
└ document.epub

注意点

• 
  

  中のシェルスクリプトには rm -r なども含まれているので、使用にはご注意ください。 コンパイルを開始する前に dest ディレクトリ内の *.epub ファイルと temp ディレクトリの中全てを削除してクリーンな状態にする様になっています。

  
  
• 
  

  一応バリデーションは通るように書かれていますが、あまり盲信せずに一応確認するようにしましょう。 オプション で、 コンパイル完了時に epubcheck を実行する事も出来るようになっています。 （別途 epubcheck のインストールが必要です）

  
  
• 
  

  grunt-mdeb を使用して被ったいかなる損害についても、対応はいたしかねます。

  
  

まとめ

私は物を書くときにいつも Markdown だったので、 そのまま EPUB に出来たら楽だろうな、と思って作ってみたパッケージです。 ブログを Markdown で書かれている方も多いと思うので、 何かの役に立つことがあれば。

追記

2014/02/13

サンプルコードの initConfig の中身が間違っていたので修正

JavaScript Alphabetical Advent Calendar 2013

JavaScript Alphabetical Advent Calendar 2013

こちらが制作してみた書籍になります。 基本的にはブログで掲載した内容とあまり変わりませんが、 リリースにあたって少し加筆修正などをしています。

Kindle ストアでの自費出版の手順

以下が出版までに踏んだ手順です。

1. EPUBデータを制作する
2. epubcheck でバリデーションする
3. kindlegen でKindle用のデータに変換する
4. Kindle プレビューツールで内容を確認する
5. Kindle Direct Publishing に登録する
6. データを送って審査をうける
7. リリース

1. EPUBデータを制作する

Kindle ストアにデータを送る前に、EPUB データとして書籍を制作します。

EPUB データの中身はXHTMLなのでWeb制作者の方ならそのまま記述していっても良いのですが、 インデックスなどを作るのが面倒だったので、 私は Markdown ファイルから EPUB データを生成する Grunt タスクを自前で書いて使いました。 （体裁が整ったらそのタスクも後日紹介するかもしれません） あるいは、sigil という電子書籍専用のエディタもあるので、導入してみてもよいかもしれません。

• sigil – The EPUB Editor – Google Project Hosting

編集中の内容の確認には電子書籍ビューアを活用しますが、 各プラットフォーム向けに色々開発されており、それぞれ良い点悪い点などあるので試してみましょう。 私は Adobe Digital Editors で確認をしました。

• Digital publishing for professionals | Adobe Digital Editions Home

2. epubcheck でバリデーションする

EPUB データが正しい情報を揃えているかどうかをチェックするツールが IDPF（International Digital Publishing Forum）からリリースされているので、 それを使ってバリデーションを行います。

• IDPF/epubcheck

上記URLの「リリース」から最新版（執筆時点の最新バージョンは3.0.1）の epubcheck をダウンロードして任意の場所に保存し、 epubcheck-x.x.x.jar を java コマンドに渡して使用します。

$ java -jar /the/path/to/epubcheck-3.0.1.jar mybook.epub

バリデーション結果は次のような感じにターミナルで出力されます。

Epubcheck Version 3.0.1

Validating against EPUB version 3.0
No errors or warnings detected.

3. kindlegen でKindle用のデータに変換する

EPUB をKindle書籍データに変換するツールは、Amazon KDP からリリースされています。

• Amazon Kindleダイレクト・パブリッシング：AmazonのKindleストアでの自費出版に関するヘルプ

上記URLから各プラットフォーム向けのコマンドラインツールがダウンロード出来ます。 中にある kindlegen （あるいは kindlegen.exe） に EPUB ファイルを渡して実行すると Kindle 形式の .mobi ファイルが同じディレクトリに生成されます。

$ kindelegen mybook.epub

生成中はエラーなどの情報がターミナルに出力されます。 エラーが出た場合は EPUB の構成を見なおして修正し、再度実行します。

Kindle Comic Creator

EPUBからの変換をする kindlegen の他に、コミックや絵本など、画像をベースにした書籍の制作用のツールも同じURLで提供されています。 こちらもそのうちに試してみたいですね。

4. 端末やプレビューツールで内容を確認する

Kindle プレビューツール も Amazon KDP から公開されているので、そちらで確認を行います。 Kindle Fire HD / Kindle Fire HDX / Kindle Fire HDX 8.9″ の各モードでプレビューする事ができます。

私は手元に iPad mini しかなかった為、試しに iPad に送って閲覧してみましたが、 iOS版の Kindle は少し別の扱いをされているらしく、実際に KDP で販売しないとスタイルシートがほとんど無視されてしまいます。

販売後にダウンロードして閲覧したところ、きちんと表示されました。 これは正直なんとかしてほしいところですが、諸々の都合がありそうですね。

5. Kindle Direct Publishing に登録する

KDP のサービスにサインインします。 ログインするだけならすぐに出来ますが、そのままでは書籍はまだ販売できません。 販売にあたっては税の云々・署名の云々・支払いの云々でもう少し時間を割く事になります。

» Amazon Kindleダイレクト・パブリッシング：AmazonのKindleストアで自費出版を

具体的には、米国の市民権を持っているか・税法的にどうなの的な事を聞かれ、デジタル署名をする事になります。 私は生粋の日本人です。

6. データを送って審査を受ける

ダッシュボードの「新しいタイトルを追加」から、作った書籍を本棚に登録します。 タイトルや著者などの基本情報から、著作権の情報、価格とロイヤリティなどを設定し、書籍データを送信し、 送信後に審査がはじまって12時間ぐらいで結果が送られてきます。

権利関係の確認

私の場合はブログ記事の書籍化だった為、 「このサイトの内容を使ってるみたいだけど権利関係は大丈夫？」 という旨のメールが送られてきました。 「権利関係をすでに解決している場合」と「していない場合」の対応手順もメールに明記されていましたが、 いくつかわからない事があったのでその旨返信すると、数時間後に回答メールが届きました。 通知専用のアドレスではなくちゃんと担当者に届く様です。

価格とロイヤリティ

ロイヤリティには35%と70%の2種類がありますが、2.99〜9.99ドルの価格設定をしないと70%は選択できません。 執筆時点の日本円での価格設定は250円〜1250円です。 今回販売した物は120円にしたので1冊あたり40円ちょっとという事になりますね。

7. リリース

審査が通って出版されると、KDPから「提出された本がKindleストアで出版されました！やったね！」というメールが届きます。 お疲れ様でした！

まとめ

慣れてしまえば簡単に自費出版出来てしまいます。KDPすごい。 とりあえずおおまかな流れは把握出来ましたが、端末毎や Kindle の癖などもありそうなので、 これから色々試してみたいと思います。