Browse files

Readme updates and a small css tweak

  • Loading branch information...
1 parent 71309a4 commit 8c135c29e3d986839eb141c2b5103d76ad05ed3d Brian committed Oct 4, 2008
Showing with 15 additions and 24 deletions.
  1. +12 −12 README
  2. +3 −12 rdoc/generators/template/ajax/ajax.rb
@@ -1,15 +1,10 @@
README for ajax-rdoc - the javascript enhanced rdoc template
-The files included in this first release allow you to create a javascript enhanced rdoc (similar to what is on right now).
+This template creates a javascript enhanced rdoc (similar to what is on ).
-Switch over to the directory where you want to run this rdoc template
-rdoc --fmt ajax
-Some shortcuts
== Installation
-1) Get the files
+1) Get the files (pick your flavor)
* tarball:
* git: git clone git://
@@ -24,16 +19,21 @@ Some shortcuts
5) This should start the generator and you'll have your new rdoc template in no-time! It should be in a folder called "doc"
-alias jaxdoc="rdoc --fmt ajax --exclude .*generator.* --exclude .*test.* --exclude .*spec.*"
+For a shortcut you might try adding this to your .bash_profile
+>alias ajaxrdoc="rdoc --fmt ajax --exclude .*generator.* --exclude .*test.* --exclude .*spec.*"
+Thanks to:
+Tien Dung ( for a neat title insertion hack. The title of your rails documentation is pulled from the
+directory name (with some humanizing). For example, standing in this directory /blah/ruby/rails-2.1.0 and running rdoc --fmt ajax
+will create a title "Rails 2.1.0" for the generated documentation pages.
+John Nunemaker ( for the addition of the installation rake task.
+Also, for the very nice QuickSilver search failover if an exact name match is not found. Very nice indeed!
Alternatively you can set this env var and run the documentation generator from anywhere (ie your home dir)
-export RUBYLIB=~/Usersbrian/rails/src/ajax-rdoc (for example)
+>export RUBYLIB=~/Usersbrian/rails/src/ajax-rdoc (for example)
@@ -185,7 +185,7 @@ def self.title
#listScroller ul{
- width: 500px;
+ width: 600px;
list-style: none;
@@ -195,7 +195,7 @@ def self.title
padding: 0px;
margin: 0px;
display: block;
- line-height: 1em;
+ line-height: 1.1em;
#listScroller a{
@@ -431,9 +431,6 @@ def self.title
<a href="#" onclick="jsHref('%full_path_url%');">%full_path%</a>
-&nbsp;(<a href="#" onclick="jsHref('%cvsurl%');">CVS</a>)
@@ -600,8 +597,6 @@ def self.title
!INCLUDE! <!-- banner header -->
@@ -630,11 +625,7 @@ def self.title
<table class="header-table">
<tr class="top-aligned-row">
- <td>%full_path%
- &nbsp;(<a href="%cvsurl%"><acronym title="Concurrent Versioning System">CVS</acronym></a>)
- </td>
+ <td>%full_path%</td>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>

0 comments on commit 8c135c2

Please sign in to comment.