Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

docrails_kindle

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

docrails_kindle

  • 0.0.5
  • Rubygems
  • Socket score

Version published
Maintainers
1
Created
Source

docrails_kindle

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

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

Download Guide

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

Download Rails Guides ebook

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

Also, if the DocsRails team would like to incorporate and adapt this code for their project, please go for it.

Author

Daniel Choi http://github.com/danchoi

FAQs

Package last updated on 18 Jan 2012

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc