Skip to content
This repository

a generic EPUB library for Ruby : supports EPUB 3

README.md

gepub

Coverage Status Dependency Status Gem Version

DESCRIPTION:

a generic EPUB parser/generator library.

FEATURES/PROBLEMS:

  • GEPUB::Book provides functionality to create EPUB file, and parsing EPUB files
  • Handle every metadata in EPUB2/EPUB3.
  • GEPUB::Builder provides an easy and powerful way to create EPUB3 files

  • See issues for known problems.

SYNOPSIS:

Builder Example

require 'rubygem'
require 'gepub'
builder = GEPUB::Builder.new {
  language 'en'
  unique_identifier 'http:/example.jp/bookid_in_url', 'BookID', 'URL'
  title 'GEPUB Sample Book'
  subtitle 'This book is just a sample'

  creator 'KOJIMA Satoshi'

  contributors 'Denshobu', 'Asagaya Densho', 'Shonan Densho Teidan', 'eMagazine Torutaru'

  date '2012-02-29T00:00:00Z'

  resources(:workdir => '~/epub/sample_book_source/') {
    cover_image 'img/image1.jpg' => 'image1.jpg'
    ordered {
      file 'text/chap1.xhtml'
      heading 'Chapter 1'

      file 'text/chap1-1.xhtml'

      file 'text/chap2.html'
      heading 'Chapter 2'
    }
  }
}
epubname = File.join(File.dirname(__FILE__), 'example_test_with_builder.epub')
builder.generate_epub(epubname)

more builder examples examples in this repository

INSTALL:

  • gem install gepub

endorse

Something went wrong with that request. Please try again.