Literate Ruby

Name

The name is inspired by Literate Haskell.

Installation

This gem can be install using gem as follows:

gem install LiterateRuby

Executable

The executable for this is called lruby. It can be used as such

lruby file.lrb

Usage

A file like this

This is some commentary on ruby code,
and here is some more commentary.

> puts 'this is executable ruby code'
> # of course, you can include comments
> # in here, but why would you?
> class A
>  def you_can_define
>    @classes_and_such = 'in here'
>  end
>  # if you want to 
> end 

This is called bird style. There are specs on it here.

Future

In the future LaTeX might be used in here as well.