https://github.com/krisquigley/ebook_generator

Rails gem for generating ebooks
https://github.com/krisquigley/ebook_generator

Last synced: 3 days ago
JSON representation

Rails gem for generating ebooks

• Host: GitHub
• URL: https://github.com/krisquigley/ebook_generator
• Owner: krisquigley
• License: mit
• Created: 2014-04-17T11:54:41.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-03-09T12:23:04.000Z (over 7 years ago)
• Last Synced: 2024-05-02T01:44:15.913Z (7 months ago)
• Language: Ruby
• Homepage: http://dskri.be
• Size: 83 KB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
# EbookGenerator

Rails gem to generate eBooks using the Markdown syntax to format content for sections of the book.

An example of this gem being used can be found at: [dskri.be](http://dskri.be)

Requires:

- Rails 4

- Rubyzip (to generate the .epub)

- Redcarpet (to render Markdown into HTML)

- Kindlegen (to generate .mobi files)

## Installation

Add this line to your application's Gemfile:

    gem 'ebook_generator'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install ebook_generator

## Usage

Generate the tables needed to process the ebooks:

`rails generate ebook_generator`

Migrate the database:

`rake db:migrate`

Pass the ebook object you want to generate:

`EbookGenerator.generate_ebook(ebook_object)`

This will then generate an ePub based on the values in the db and output to the /tmp folder.

For a Kindle mobi file then pass in `kindle` as the second argument:

`EbookGenerator.generate_ebook(ebook_object, 'kindle')`

To enable the generation of Kindle mobi files then you will first need to download the [kindlegen](http://www.amazon.com/gp/feature.html?docId=1000765211)

command line tool from Amazon and put it in your apps `/bin` directory.

## Feature roadmap

### 1.1.0

- Style editing

### 1.2.0

- PDF out

### 1.3.0

- HTML out

- Image support for the front cover

### 1.4.0

- HTML to eBook conversion

## Contributing

1. Fork it ( https://github.com/[my-github-username]/ebook_generator/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