Skip to content
A(nother) HTML generator for RDoc
Ruby JavaScript CSS Shell
Find file
Failed to load latest commit information.
assets
data/rdoc-generator-fivefish Use the method list given to the layout template instead of re-adding… Mar 13, 2013
lib Update for Ruby 2.2, newer RSpec. Mar 17, 2015
spec
tasks Fix js asset-generation Feb 27, 2013
.autotest Initial hoe project template Mar 11, 2012
.gems Update for Ruby 2.2, newer RSpec. Mar 17, 2015
.hgignore Merged with e198a1b8b529 Apr 4, 2012
.hgsigs Added signature for changeset 55973eb0bf4f Mar 26, 2013
.hgtags Added tag v0.1.0 for changeset b08f3b479c38 Mar 26, 2013
.hoerc Checkpoint of generated assets change Apr 3, 2012
.rvmrc Update for Ruby 2.2, newer RSpec. Mar 17, 2015
.tm_properties Fix indentation settings in project properties Mar 13, 2013
History.rdoc Bump minor version, update history Mar 25, 2013
Manifest.txt Update for Ruby 2.2, newer RSpec. Mar 17, 2015
README.rdoc
Rakefile Add specs for generation Mar 25, 2013

README.rdoc

Fivefish RDoc

Description

A(nother) HTML(5) generator for RDoc.

It uses Twitter Bootstrap for the pretty, doesn't take up valuable horizontal real estate space with indexes and stuff, and has a QuickSilver-like incremental searching.

Installation

gem install rdoc-generator-fivefish

Usage

rdoc --format=fivefish

Development

You'll need a few tools to make a gem from source:

Contributing

You can check out the current development source with Mercurial, or if you prefer Git, via the project's Github mirror.

After checking out the source, run:

$ rake newb

This task will install any missing dependencies, run the tests/specs, and generate the API documentation.

License

Copyright © 2012, Michael Granger All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the author/s, nor the names of the project's contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Fivefish makes extensive use of the Twitter Bootstrap framework, which is used under the following license terms:

Copyright 2012 Twitter, Inc.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Something went wrong with that request. Please try again.