Skip to content

jugyo/eeepub

Folders and files

NameName
Last commit message
Last commit date

Latest commit

e120406 · Mar 21, 2013
Sep 19, 2011
Mar 20, 2013
Sep 26, 2012
May 7, 2011
May 7, 2011
May 2, 2010
Oct 25, 2010
May 7, 2011
Mar 5, 2013

Repository files navigation

EeePub

EeePub is a Ruby ePub generator.

Usage

epub = EeePub.make do
  title       'sample'
  creator     'jugyo'
  publisher   'jugyo.org'
  date        '2010-05-06'
  identifier  'http://example.com/book/foo', :scheme => 'URL'
  uid         'http://example.com/book/foo'

  files ['/path/to/foo.html', '/path/to/bar.html'] # or files [{'/path/to/foo.html' => 'dest/dir'}, {'/path/to/bar.html' => 'dest/dir'}]
  nav [
    {:label => '1. foo', :content => 'foo.html', :nav => [
      {:label => '1.1 foo-1', :content => 'foo.html#foo-1'}
    ]},
    {:label => '1. bar', :content => 'bar.html'}
  ]
end
epub.save('sample.epub')

Low Level API

Create NCX:

EeePub::NCX.new(
  :uid => 'xxxx',
  :title => 'sample',
  :nav => [
    {:label => '1. foo', :content => 'foo.html'},
    {:label => '2. bar', :content => 'bar.html'}
  ]
).save(File.join('sample', 'toc.ncx'))

Create OPF:

EeePub::OPF.new(
  :title => 'sample',
  :identifier => {:value => '0-0000000-0-0', :scheme => 'ISBN'},
  :manifest => ['foo.html', 'bar.html'],
  :ncx => 'toc.ncx'
).save(File.join('sample', 'content.opf'))

Create OCF and ePub file:

EeePub::OCF.new(
  :dir => 'sample',
  :container => 'content.opf'
).save('sample.epub')

Install

gem install eeepub

Requirements

  • builder
  • eBook Reader :)

Links

Copyright

Copyright (c) 2010 jugyo. See LICENSE for details.

About

EeePub is a Ruby ePub generator

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages