Ebook Boilerplate

screenshot of Ebook Boilerplate

A lightweight boilerplate for self-publishing ebooks with markdown and command line.

Overview:

The Ebook Boilerplate is a lightweight boilerplate designed for self-publishing ebooks using markdown and the command line. It offers the functionality to transform markdown files into various file formats including PDF, EPUB, MOBI, and HTML. Additionally, it provides a zipped version of the ebook containing all four formats. Please note that while this boilerplate works in MacOS, it has not been tested in Windows.

Features:

  • Multiple File Format Conversion: Transform markdown files into PDF, EPUB, MOBI, and HTML files.
  • Zip Version: Provides a zipped version of the ebook containing all four file formats.
  • Customizable Book Metadata: Add book title, subtitle, author info, and more to the metadata.yml and title.md files in the assets directory.
  • Flexible Project Structure: Save book content as markdown files in the chapters directory, and book assets such as CSS and metadata in the assets directory.
  • Image Support: Ability to include project images in the assets/img directory and reference them in chapters relative to the root directory.
  • PDF Cover: Option to include a cover.pdf file in the assets directory to use as a cover for PDF files.
  • Configuration Options: Customize the Ebook Boilerplate by changing defaults in the build.sh file or passing flags with the sh build.sh command.

Summary:

The Ebook Boilerplate is a convenient tool for self-publishing ebooks using markdown and the command line. With its ability to convert markdown files into multiple file formats and its customizable features, it provides an efficient workflow for ebook creation. Users can easily structure their projects, include images, and configure various options. Although there are some quirks and limitations with certain file types, overall, the Ebook Boilerplate is a useful resource for authors and publishers looking to create ebooks.