Krammer

A (Markdown -> PDF) convertor written in Ruby.

Installation

Add this line to your application's Gemfile:

gem 'krammer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install krammer

Requirements

This project currently supports OS X Mavericks.

The project requires the installation of kramdown and pdflatex, which is included in the MacTex distribution.

Usage

First, set the shell variable KRAMMER_AUTHOR and KRAMMER_TEMPLATE as follows:

$ export KRAMMER_AUTHOR="Name"
$ export KRAMMER_TEMPLATE="/path/to/template.erb"

You can put these lines in your .bash_profile/.bashrc file for persistence.

Then type:

$ cd /path/to/project/directory
$ krammer

or:

$ krammer /path/to/project/directory

Contributing

1. Fork it ( https://github.com/[my-github-username]/krammer/fork )
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 a new Pull Request

License

The license is located here.