Skip to content

Pelican plugin that saves articles and pages as PDF files

License

Notifications You must be signed in to change notification settings

pelican-plugins/pdf

Repository files navigation

PDF Generator: A Plugin for Pelican

Build Status PyPI Version Downloads License

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/

Installation

This plugin can be installed via:

python -m pip install pelican-pdf

As long as you have not explicitly added a PLUGINS setting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must add pdf to your existing PLUGINS list. For more information, please see the How to Use Plugins documentation.

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.

Contributors

Contributors include: Dominik Wombacher, Justin Mayer, Kyle Mahan, Renato Cunha, dpetzel, and Lucas Cimon

Contributing

Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on existing issues.

To start contributing to this plugin, review the Contributing to Pelican documentation, beginning with the Contributing Code section.

License

This project is licensed under the AGPL 3.0 license.