public
Description: Your local Gem browser
Homepage: http://manalang.com/archives/2009/03/29/introducing-bdoc-a-better-gem-doc-browser/
Clone URL: git://github.com/manalang/bdoc.git
bdoc /
name age message
file History.txt Mon Jun 08 08:58:50 -0700 2009 escaping issues and new version [manalang]
file Manifest.txt Thu Apr 02 19:33:06 -0700 2009 inlined bdoc.css [manalang]
file PostInstall.txt Mon Oct 05 11:14:54 -0700 2009 updated for newgem 1.5.1 compat [manalang]
file README.rdoc Thu Oct 22 13:24:06 -0700 2009 updated demo url [manalang]
file Rakefile Mon Oct 05 11:14:54 -0700 2009 updated for newgem 1.5.1 compat [manalang]
directory bin/ Mon Mar 30 14:43:58 -0700 2009 bug fixes [manalang]
directory lib/ Mon Jun 08 08:58:50 -0700 2009 escaping issues and new version [manalang]
directory script/ Mon Oct 05 11:14:54 -0700 2009 updated for newgem 1.5.1 compat [manalang]
directory templates/ Mon Jun 08 08:58:50 -0700 2009 escaping issues and new version [manalang]
directory test/ Sat Mar 28 22:12:44 -0700 2009 initial commit [manalang]
README.rdoc

Bdoc

DESCRIPTION:

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

Check out the demo manalang.github.com/bdoc

Install

  [sudo] gem install manalang-bdoc

Usage

  bdoc

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

Specify output directory

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

  bdoc /path/to/bdoc

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.