Bdoc

Bdoc is a simple replacement for gem server. All it does is look at all of the Gems you have installed locally and creates a nice iframe based browser that makes it easy to navigate between gem docs. IT DOES NOT REQUIRE A SERVER FOR VIEWING… not like gem server does!

If you use this, I highly suggest also using Hanna (a beautiful rdoc theme).

This fork of bdoc uses the LiquidMetal scoring algorithm so you don’t have to worry about typo’s in your search queries (github.com/rmm5t/liquidmetal/tree/master).

Other features include:

  • Search your local gems (instead of browsing through a list)

  • Multiple rdocs open simultaneously

  • Search the API of every gem

Install

[sudo] gem install pietern-bdoc

Usage

bdoc

That’s it! This will create an index of all your local gems then launch your default browser. Enjoy!

Controls

When bdoc is loaded, press space to search for a gem. When a gem is loaded, just start typing to find the file/class/method you’re looking for. To switch between different tabs use Shift+→ and Shift+←.

Specify output directory

Optionally you can specify the output directory on the command line:

bdoc /path/to/bdoc

Hints

For even easier access to the docs of your local gems, create a Fluid.app instance for bdoc. Then, edit your Bdoc.app/Contents/Resources/Config.plist to point to some location on your drive (e.g. /Users/<yourname>/.bdoc/index.html) and schedule a cronjob to recreate the bdoc index every once in a while. At least, this works for me.

Authors

  • Rich Manalang (original author of bdoc)

  • Pieter Noordhuis

LICENSE:

(The MIT License)

Copyright © 2009 Rich Manalang

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.