0.0
No release in over 3 years
Converts markdown files into PDF documents using options passed in a hash.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

~> 2.5, >= 2.5.0
~> 0.1.16
~> 1.6.5
~> 3.6.1, >= 3.6.1
 Project Readme

petit-felix

Gem Version

petit-felix is a document generator ruby gem and standalone command line program that can input markdown files and produce very nice looking outputs depending on the worker assigned. You can use this to turn markdown files, specifically those used on Jekyll posts, into a printable format that looks nice. If your markdown files are not formatted like Jekyll files, it is easy to update them to work with petit-felix.

If you're just getting started, check out the Quickstart Guide. But if you want to know more about petit-felix, check out the Documentation.

Quickstart Guide

If you just want to run petit-felix out of the box and have Ruby, Rubygems and Bundler installed, download the contents of the repository:

git clone git@github.com:badgernested/petit-felix.git

Then, install the dependencies:

bundle install

Then, just run it with ruby.

bundle exec ruby ./petit-felix.rb [arguments]

This will process the files in ./md and output them to a new directory, ./output.

To view other ways to use petit-felix, refer to the usage documentation.

Documentation

  1. Introduction to petit-felix
  2. Using petit-felix
  3. Introduction to Workers
  4. Introduction to Tasks