https://github.com/javierarce/epub-boilerplate

A simple template to help you create ePub-formatted books.
https://github.com/javierarce/epub-boilerplate

epub epub-boilerplate epub-validation epubcheck

Last synced: 26 days ago
JSON representation

A simple template to help you create ePub-formatted books.

• Host: GitHub
• URL: https://github.com/javierarce/epub-boilerplate
• Owner: javierarce
• License: mit
• Created: 2012-05-15T07:29:22.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2016-11-29T15:15:20.000Z (over 8 years ago)
• Last Synced: 2025-04-22T23:09:17.469Z (26 days ago)
• Topics: epub, epub-boilerplate, epub-validation, epubcheck
• Language: HTML
• Homepage:
• Size: 14.2 MB
• Stars: 161
• Watchers: 13
• Forks: 17
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
ePub Boilerplate

================

A simple template that helps you build ePub-formatted books.

## How to use the template

1. Clone the repo:

        $ git clone [email protected]:javierarce/epub-boilerplate.git

2. Edit the contents of the ``book`` directory1.

3. Run the publish script to generate and validate the book:

        $ ./publish book

1: You'll find comments inside several files to guide you.

## Structure of a book

Here's the structure of the sample book included in the repo:

    ▾ book/

      ▾ META-INF/

          com.apple.ibooks.display-options.xml

          container.xml

      ▾ OEBPS/

        ▾ Images/

            cover.jpg

            image-01.jpg

            image-02.png

        ▾ Styles/

            style.css

        ▾ Text/

            acknowledgements.xhtml

            chapter01.xhtml

            chapter02.xhtml

            chapter03.xhtml

            cover.xhtml

            dedication.xhtml

            endnotes.xhtml

            foreword.xhtml

            frontmatter.xhtml

            introduction.xhtml

            toc.xhtml

          content.opf

          toc.ncx

        mimetype

## ePub validation

This project uses [epubcheck](https://github.com/IDPF/epubcheck) to validate the generated ePubs. If the ``build.sh`` script complains when running ``epubcheck``, make sure you have java installed and it's in your ``PATH``.

If you need help running ``epubcheck`` read this step-by-step guide.

## How to check your ebook

It's super easy. Just do:

    $ ./check book.epub

This project currently uses EpubCheck version 4.0.

## Style

*Caveat lector*: currently there aren't any defined styles. While I add a basic layout have a look at the ePub CSS Starter Kit.

## ePub → mobi

If you want to transform your ``.epub`` file to ``.mobi`` do this:

1. Download [KindleGen](http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211).

2. Uncompress the file.

3. Copy the ``kindlegen`` executable to the ``bin`` folder.

4. Run ``./bin/kindlegen book.epub``.

## Useful resources

#### EPUB 3

* [EPUB 3.0 spec](http://idpf.org/epub/30)

* [What Is EPUB 3? An Introduction to the EPUB Specification for Multimedia Publishing](http://shop.oreilly.com/product/0636920022442.do)

#### Metadata

* [UUID generator](http://www.famkruithof.net/uuid/uuidgen)

* [BISAC Subject Headings List](http://bisg.org/?page=BISACFaQ)

* [Practical ePub metadata: Authorship](http://blog.threepress.org/2009/11/27/practical-epub-metadata-authorship/)

* [MARC Code List for Relators](http://www.loc.gov/marc/relators)

#### Styling

* [ePub CSS Starter Kit](https://github.com/mattharrison/epub-css-starter-kit)

#### Validation

* [ePub Validator](https://github.com/IDPF/epubcheck)

#### Compatibility and rendering issues

* [Device compatibilty chart](http://wiki.mobileread.com/wiki/Device_Compatibility)

* [99problems: A global list of e-reader rendering bugs](https://github.com/dvschultz/99problems)