a generic EPUB library for Ruby : supports EPUB 3
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
examples fix an example sccript: generate_example.rb May 3, 2018
lib
spec add failing spec May 23, 2018
.gitattributes added gitattributes May 22, 2012
.gitignore
.travis.yml update .travis.yml Apr 14, 2018
Gemfile add coverall Jan 28, 2014
LICENSE.txt
README.md README: fix rendering error(?) in GitHub May 2, 2018
Rakefile remove rdoc documents from repository May 25, 2014
gepub.gemspec

README.md

gepub

Gitter 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.

If you are using GEPUB::Builder from your code and do not like its behaviour(e.g. the block inside is evaluated as inside the Builder instance), please consider using GEPUB::Book directly.

GEPUB::Builder will be obsolete in gepub 0.7. GEPUB::Book#new will be enhanced instead of Builder DSL.

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