A guide on how to use sdoc and Fluid.app to create one-place searchable documentation
JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.markdown
sdoc.zip

README.markdown

What is it?

An offline searchable documentation that includes both Ruby v.1.9.2 Rails v.3.1.1. Searchable Ruby and Rails Doc with Fluid.app

Installation

Download a compiled and merged doc

  • Download with Git:

            mkdir -p ~/Documents/SDocs
            cd ~/Documents/SDocs
            git clone git@github.com:JonasNielsen/Ruby-and-Ruby-on-Rails-Searchable-docs.git "Ruby v.1.9.2 Rails v.3.1.1"
            cd Ruby\ v.1.9.2\ Rails\ v.3.1.1
            unzip sdoc.zip 
            open sdoc/
    
  • Open index.html and copy the url

Slick it up with Fluid.app

Fluid.app

For only 4.99$ you can get extra features, such as Full Screen mode in Lion

Credits

All I did was compile and merge the documentations and create this guide. The real credit goes to:

@voloko the author of http://github.com/voloko/sdoc

@iTod the author of http://fluidapp.com/

If you use this stuff, I would love to hear about it @JonasNielsen