md2ebook 0.1.1

Requirements

• Calibre (especially its command-line-interface tools)

• Pandoc

• Python

• epubcheck (this one’s optional)

Please note that you need either Calibre or Pandoc (or both) to generate EPUB files, but you need Calibre (and its CLI tools) to check the EPUB conformity.

pip install -e ./

Usage

to start a new book, just create a new project with the following command:

md2ebook start

or, alternatively:

md2ebook start directory-name

When you’re done, you can move to this directory and use the build command:

md2ebook build

This will build a HTML and a EPUB version of your book, as defined in the book.json file.

md2ebook check

md2ebook --help

Configuration file

At the root of your book directory, you have a book.json file which contains your book configuration. This file is mandatory.

Here are its mandatory options, as a complete example:

{
    "files": ["chapter1.md", "chapter2.md", "chapter3.md"],
    "author": "Joe A. Nonymous",
    "title": "What a beautiful title",
    "fileroot": "what-a-beautiful-title",
    "generator": "calibre"
}

• files is a list of markdown files that live in your book root directory. They’ll be processed in that specific order and compiled into a single ebook.

• author is the name of the author of the book.

• title is the title of the book, in its full glory.

• fileroot this string will serve as a root for the different outputs. Following the example, you’ll produce what-a-beautiful-title.html and what-a-beautiful-title.epub in your book root directory.

• generator is either “calibre” or “pandoc”. Pick the one you prefer (or the one that is available on your system).

{
"files": [
    "book.md"
],
"title": "Les 3 Mousquetaires",
"fileroot": "les-3-mousquetaires",
"author": "Alexandre Dumas",
"extensions": ["admonitions", "toc", "footnotes"],
"generator": "pandoc"
}

"extensions": ["headerid(level=3)"]

Credits

This piece of software is Copyleft 2013 - Bruno Bord.

It is released under the terms of the MIT License, see LICENSE file for more details.