Ruby and Ruby on Rails offline API documentation [closed]

Browser-based Solution – Updated Oct 19, 2017

DevDocs (https://devdocs.io/) uses your browser’s IndexedDB to store the documentation you want. Make sure you follow the instructions on how to install the docs before you go offline.

For macOS try Dash

For Windows/Linux try Zeal

For packaged HTML try RubyDocs

Manual Download:

I used this commands on my server so I could get the files faster (they were cached, go figure).

wget -r -k -p http://api.rubyonrails.org/

• r – recursive
• k – convert links to point to local files
• p – get all
  images, etc needed to display the html pages

Then I compress the folder so I can download it without overhead.

rar a -r rails_api.rar api.rubyonrails.org/

• a – add files
• r – recursive

https://gist.github.com/2149669

YARD Server

I prefer the yard format over rdoc.

1. Install the gem gem install yard,
2. Regenerate all the documentation gem rdoc --all --overwrite, and
3. Run the server for the gems yard server --gems.