Aladdin

Build Status Dependency Status Code Climate

Generates lessons using the markdown document and tests provided by the author.

Installation

Add this line to your application's Gemfile:

gem 'aladdin'

And then execute:

$> easy_install Pygments
$> bundle install

Or install it yourself as:

$> easy_install Pygments
$> gem install aladdin

Usage

Create a new directory for your notes e.g. lesson_0. Change into that directory, then execute:

$> aladdin new

Update index.md and provide your unit tests in the lesson directory. Finally, execute aladdin to launch the Sinatra server:

$> aladdin server

A short guide can be obtained using

$> aladdin --help

Note that the following filenames are reserved:

  • __js
  • __css
  • __font
  • __img
  • verify

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Troublesome Parts

  1. Launch an Ubuntu instance
  2. Install ruby through rvm
  3. Install build-essentials
  4. Install libxslt-dev libxml2-dev