https://github.com/jugyo/eeepub

EeePub is a Ruby ePub generator
https://github.com/jugyo/eeepub

Last synced: 4 days ago
JSON representation

EeePub is a Ruby ePub generator

• Host: GitHub
• URL: https://github.com/jugyo/eeepub
• Owner: jugyo
• License: mit
• Created: 2010-05-02T13:13:07.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2013-03-21T03:24:11.000Z (over 11 years ago)
• Last Synced: 2024-05-23T05:10:08.663Z (5 months ago)
• Language: Ruby
• Homepage:
• Size: 213 KB
• Stars: 218
• Watchers: 9
• Forks: 61
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ruby - Eeepub - EeePub is a Ruby ePub generator. (Ebook)
• starred-awesome - eeepub - EeePub is a Ruby ePub generator (Ruby)

README

        
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

-------

* Documentation: [http://yardoc.org/docs/jugyo-eeepub](http://yardoc.org/docs/jugyo-eeepub)

* Source code: [http://github.com/jugyo/eeepub](http://github.com/jugyo/eeepub)

Copyright

-------

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