An(other) alternative generator for RDoc
Adding release checksum.
Added tag v0.1.0 for changeset 1593f5b4a0bd

heads

tip
browse log
v0.1.0
browse .tar.gz

clone

read-only
https://hg.sr.ht/~ged/Sixfish
read/write
ssh://hg@hg.sr.ht/~ged/Sixfish

#Sixfish RDoc

home : https://hg.sr.ht/~ged/Sixfish

code : https://hg.sr.ht/~ged/Sixfish

github : https://github.com/ged/sixfish

docs : https://deveiate.org/code/sixfish

#Description

A readable HTML generator for RDoc. It uses the Bulma CSS framework.

#Installation

gem install rdoc-generator-sixfish

#Usage

rdoc --format=sixfish

#Contributing

You'll need Yarn to build this gem.

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 and changing into the new directory, run:

$ gem install -Ng
$ rake setup

This task will install dependencies, and do any necessary development setup.

#Authors

#License

This uses the Bulma CSS Framework, and a licensed version of Font Awesome Pro 5.

Sixfish itself is:

Copyright © 2015-2022, 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.