0.0
No commit activity in last 3 years
No release in over 3 years
Read Rails Guides on your Kindle
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

docrails_kindle

This gem lets you generate a Kindle version of the Ruby on Rails Guides with working section and article navigation.

screen screen

The DocRails project does provide its own experimental Rake task to generate a Kindle version of the Rails Guides. However, its section and article navigation doesn't work correctly (at least on a Kindle Touch).

This tool depends on the kindlerb gem, which decouples the process of structuring a ebook document into sections and articles from the low-level details of OPF and NCX templating.

If you just want the eBook

If you just want to download the ebook I generated with this tool, here it is:

But to keep up with updates to the Rails Guides, you may want to periodically generate the Rails Guides ebook yourself. For this, please read on.

Install

gem install docrails_kindle

Prerequisistes

Download KindleGen 2 and put it on your PATH.

How to use

gem install docrails_kindle
git clone git@github.com:lifo/docrails.git
cd docrails/railties/guides
KINDLE=1 rake generate_guides
cd output/kindle
docrails_kindle

The output document will be called something like rails-guide.2012-11-18.mobi. Don't confuse it with the other mobi document that gets generated by rake generate_guides, which looks like ruby_on_rails_guides_16c5f48.mobi.

You can transfer this mobi file to your Kindle.

Contribute

This program is a rough prototype. Some internal links may not work. The css styling may need to be improved. Other bugs may exist. Please file issues or fork and submit pull requests.

This code has also been adapted into a Rails commit and submitted as a pull request.

Author

Daniel Choi http://github.com/danchoi