public
Description: Wolfe is a publishing tool-chain, transforming Markdown, Textile, HTML, XHTML, or XML into a formatted PDF via CSS.
Homepage: http://wolfe.rubyforge.org
Clone URL: git://github.com/crnixon/wolfe.git
Clinton R. Nixon (author)
Thu May 29 23:31:32 -0700 2008
wolfe /
name age message
file History.txt Thu May 29 23:31:32 -0700 2008 initial commit [Clinton R. Nixon]
file LICENSE.txt Thu May 29 23:31:32 -0700 2008 initial commit [Clinton R. Nixon]
file Manifest.txt Thu May 29 23:31:32 -0700 2008 initial commit [Clinton R. Nixon]
file README.txt Thu May 29 23:31:32 -0700 2008 initial commit [Clinton R. Nixon]
file Rakefile Thu May 29 23:31:32 -0700 2008 initial commit [Clinton R. Nixon]
file TODO Thu May 29 23:31:32 -0700 2008 initial commit [Clinton R. Nixon]
directory bin/ Thu May 29 23:31:32 -0700 2008 initial commit [Clinton R. Nixon]
directory lib/ Thu May 29 23:31:32 -0700 2008 initial commit [Clinton R. Nixon]
directory tasks/ Thu May 29 23:31:32 -0700 2008 initial commit [Clinton R. Nixon]
directory test/ Thu May 29 23:31:32 -0700 2008 initial commit [Clinton R. Nixon]
README.txt
= Wolfe

Wolfe is a publishing toolchain. It converts Markdown text, HTML, XHTML, or XML to a formatted PDF, using (almost all 
of) CSS2.1 with extensions to support paged media.

It is heavily inspired by YesLogic's Prince[http://www.princexml.com], which is an amazing piece of software, but not 
open-source or free.

Wolfe uses JRuby[http://wiki.jruby.org/wiki/Main_Page] so that it can utilize two invaluable Java libraries:

- iText[http://www.lowagie.com/iText/]
- FlyingSaucer[https://xhtmlrenderer.dev.java.net/]

Both of these are packaged as gems, available on the project page[http://rubyforge.org/projects/wolfe/].

== Usage

  wolfe [options] file

Valid options are:

  -c CONVERTER
    specify a converter (markdown, html) to use

The output file will have the same name as the input file, but with .pdf as its extension.

== How to include CSS

CSS must be included in or linked from your source file. For Markdown, this may seem difficult. Because Wolfe uses 
Maruku, and has its own extensions, you can add print CSS to the top of a Markdown file like so:

  Print CSS: my_file.css