Rain is a gem to generate beautiful and customizable API documentation, inspired by yard and rdoc. The aim of Rain is to generate beautiful API documentation from a ruby comment syntax with markdown mixed in. The documentation can be inline in .rb files, or separate .md or .txt files for overall architecture documentation. Rain also allows a large amount of customization when it comes to templating and appearance of the API documentation. Branding and unity of documentation appearance is important and Rain offers a simple ERB-based template system.

Required Ruby Version

>= 0

Authors

Martin Brennan

Versions

  1. 0.0.8

    1. source

      1. 0.0.8 source December 22, 2014 (38 KB)
  2. 0.0.7

    1. source

      1. 0.0.7 source December 22, 2014 (37.5 KB)
  3. 0.0.6

    1. source

      1. 0.0.6 source December 20, 2014 (13.5 KB)
  4. 0.0.5

    1. source

      1. 0.0.5 source December 20, 2014 (13 KB)
  5. 0.0.4

    1. source

      1. 0.0.4 source December 18, 2014 (12.5 KB)
Show all versions (8 total)

SHA 256 checksum

← Previous version