The gem provides the formatters for the pivotal_to_pdf gem.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install pivotal_to_pdf-formatters
The gem needs to use with pivotal_to_pdf gem. It provides the formatters for the pivotal_to_pdf.
To use an existing formatter, Please see the pivotal_to_pdf README Formatters section.
To add a formatter, please fork this project, add you own formatter, submit a PR, and I will merge it if I decide no harm can be done and update the version. Once the new version of this gem is released, you can update the gem and your formatter should be ready for use.
A formatter must have 2 public interfaces for it to work:
initializetakes an array of stories
write_tomethod writes to the your chosen output (PDF, HTML, etc.) in your style.
Your formatter can extends from
PivotalToPdf::Formatters::Base to have
initialize method available.
Default formatter is a bad example on how to write code. I expect some tests along with your formatter.
Design it good, do not afraid adding more help classes when needed.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Added some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request