Renato Cunha fadeb851c3 Update the pdf plugin's documentation 8 years ago
..
Readme.rst fadeb851c3 Update the pdf plugin's documentation 8 years ago
__init__.py b1f33df20d Issue #1009: Moved PdfGenerator to pelican-plugins and added a basic test 10 years ago
pdf.py fadeb851c3 Update the pdf plugin's documentation 8 years ago
test_pdf.py 360f5452d5 Add support for exporting Markdown articles as PDF. Refs #573 8 years ago

Readme.rst

-------------
PDF Generator
-------------

The PDF Generator plugin automatically exports articles and pages as PDF files
as part of the site generation process. PDFs are saved to:
``output/pdf/``

Requirements
------------

You should ensure you have the ``rst2pdf`` module installed, which can be
accomplished via::

pip install rst2pdf

If you are converting Markdown sources to PDF, you also need the ``xhtml2pdf``
module, which can be installed with::

pip install xhtml2pdf

Usage
-----

To customize the PDF output, you can use the following settings in your
Pelican configuration file::

PDF_STYLE = ''
PDF_STYLE_PATH = ''

``PDF_STYLE_PATH`` defines a new path where ``rst2pdf`` will look for style
sheets, while ``PDF_STYLE`` specifies the style you want to use. For a
description of the available styles, please read the `rst2pdf documentation`_.

.. _rst2pdf documentation: http://rst2pdf.ralsina.me/handbook.html#styles

Known Issues
------------

Relative links in the form of ``|filename|images/test.png`` are not yet handled
by the PDF generator.