Skip to content
forked from gosukiwi/epubber

Ruby gem for easy EPUB generation

License

Notifications You must be signed in to change notification settings

hjbarraza/epubber

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Epubber

Gem Version

This gem allows you to easily build EPUB files programatically.

Installation

Add this line to your application's Gemfile:

gem 'epubber'

And then execute:

$ bundle

Or install it yourself as:

$ gem install epubber

Usage

Epubber's DSL is rather simple:

path = Epubber.generate do |b|
  b.title 'My First EPUB book'
  b.author 'Ramirez, Federico'
  b.description 'This is an example EPUB'
  b.url 'http://my-url.com'

  b.cover do |c|
    c.file File.new('my-image.jpg')
  end

  b.introduction do |i|
    i.content '<p>This is an introduction.</p>'
  end

  b.chapter do |c|
    c.title 'Chapter 1'
    c.content '<p>This is some content!</p>'
  end

  b.chapter do |c|
    c.title 'Chapter 2'
    c.content '<p>Some more content this is.</p>'
  end
end

# Now the `path` variable contains the full path of the generated EPUB file.
# Defaults to `#{title}.epub`

You can configure the generator

path = Epubber.generate filename: 'some-file.epub', workspace: '/tmp' do |b|
  # Ebook code here...
end

Contributing

  1. Fork it ( https://github.com/gosukiwi/epubber/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Running tests

Running tests is as easy as running rake.

About

Ruby gem for easy EPUB generation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 76.5%
  • HTML 22.7%
  • CSS 0.8%