Mirror of https://github.com/wombelix/pdf - Pelican plugin that saves articles and pages as PDF files
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Dominik Wombacher a8bc3a210f Generate PDF output for translations 2 months ago
.github/workflows Adding new files generated by the plugin template 2 months ago
pelican/plugins/pdf Generate PDF output for translations 2 months ago
.editorconfig Adding new files generated by the plugin template 2 months ago
.gitignore Adding new files generated by the plugin template 2 months ago
.pre-commit-config.yaml Adding new files generated by the plugin template 2 months ago
CONTRIBUTING.md Adding new files generated by the plugin template 2 months ago
LICENSE README replaced with new version, LICENSE added 2 months ago
README.md README replaced with new version, LICENSE added 2 months ago
pyproject.toml Adding new files generated by the plugin template 2 months ago
tasks.py Adding new files generated by the plugin template 2 months ago
tox.ini Adding new files generated by the plugin template 2 months ago

README.md

PDF Generator: A Plugin for Pelican

Build Status PyPI Version 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

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.

Known Issues

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

Contributors

Contributors include: Kyle Mahan, Renato Cunha, dpetzel, Justin Mayer, 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.