Code Monkey home page Code Monkey logo

ebook_generator's Introduction

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

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

ebook_generator's People

Contributors

krisquigley avatar

Watchers

James Cloos avatar michal panoch avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.