Home

Prawn is a pure Ruby PDF generation library that aims to make low level PDF generation tasks easy. It is currently under active development, and could be considered somewhere between alpha and beta quality software. You might be able to use it in production, but then again, you might not. If that doesn’t deter you, and you’re willing to roll up your sleeves to help fill in the gaps, read on.

Getting Started

Prawn has a lot of examples available for you to try out. These are split out by package, see prawn-core for most core functionality, prawn-layout for tables and grid based layout helpers, and prawn-format for inline styling. Although these examples are mainly designed to test our featureset rather than solve practical problems, you’ll get a good sense of what Prawn can do by looking through them. If the examples seem to cover most of your needs, there is a good chance that Prawn will work out for you.

After you’ve successfully read through and run some examples (either via git or Rubygems), you’ll want to read out project roadmap. This document explains a lot of the finer points of how we run the project, and will help you decide what versions of Prawn you should be using in your projects.