Mirror of https://github.com/wombelix/pdf - Pelican plugin that saves articles and pages as PDF files

botpub fb68ffca83 Release PDF Generator 1.0.1 3 years ago
.github 219890f9a2 Support intra-site links to source content files (#3) 3 years ago
pelican 219890f9a2 Support intra-site links to source content files (#3) 3 years ago
.editorconfig bf7ecf5b9d Adding new files generated by the plugin template 3 years ago
.gitignore bf7ecf5b9d Adding new files generated by the plugin template 3 years ago
.pre-commit-config.yaml 97b4e43d48 Update linter versions 3 years ago
CHANGELOG.md fb68ffca83 Release PDF Generator 1.0.1 3 years ago
CONTRIBUTING.md bf7ecf5b9d Adding new files generated by the plugin template 3 years ago
LICENSE 9f4a5f9dce README replaced with new version, LICENSE added 3 years ago
README.md 219890f9a2 Support intra-site links to source content files (#3) 3 years ago
pyproject.toml fb68ffca83 Release PDF Generator 1.0.1 3 years ago
tasks.py bf7ecf5b9d Adding new files generated by the plugin template 3 years ago
tox.ini bf7ecf5b9d Adding new files generated by the plugin template 3 years 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.

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.