Aladdin
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
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Troublesome Parts
- Launch an Ubuntu instance
- Install ruby through rvm
- Install build-essentials
- Install libxslt-dev libxml2-dev