| Name | pelican-pdf JSON |
| Version |
1.0.5
JSON |
| download |
| home_page | None |
| Summary | PDF Generator is a Pelican plugin that exports articles and pages as PDF files during site generation |
| upload_time | 2024-09-11 12:55:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.8.1 |
| license | AGPL-3.0 |
| keywords |
pelican
plugin
pdf
generator
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
PDF Generator: A Plugin for Pelican
===================================
[](https://github.com/pelican-plugins/pdf/actions)
[](https://pypi.org/project/pelican-pdf/)
[](https://pypi.org/project/pelican-pdf/)
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](https://docs.getpelican.com/en/latest/plugins.html#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](https://rst2pdf.org/static/manual.html#styles).
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.
[existing issues]: https://github.com/pelican-plugins/pdf/issues
[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html
License
-------
This project is licensed under the AGPL 3.0 license.
Raw data
{
"_id": null,
"home_page": null,
"name": "pelican-pdf",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8.1",
"maintainer_email": null,
"keywords": "pelican, plugin, pdf, generator",
"author": null,
"author_email": "Justin Mayer <entroP@gmail.com>, Dominik Wombacher <dominik@wombacher.cc>",
"download_url": "https://files.pythonhosted.org/packages/d1/65/d66956282b698185ae3e6b1c8157a4d52bcfed268da2f89559af210a77ca/pelican_pdf-1.0.5.tar.gz",
"platform": null,
"description": "PDF Generator: A Plugin for Pelican\n===================================\n\n[](https://github.com/pelican-plugins/pdf/actions)\n[](https://pypi.org/project/pelican-pdf/)\n[](https://pypi.org/project/pelican-pdf/)\n\n\nThe PDF Generator plugin automatically exports articles and pages as PDF files as part of the site generation process.\nPDFs are saved to: `output/pdf/`\n\nInstallation\n------------\n\nThis plugin can be installed via:\n\n python -m pip install pelican-pdf\n\nAs 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](https://docs.getpelican.com/en/latest/plugins.html#how-to-use-plugins) documentation.\n\nUsage\n-----\n\nTo customize the PDF output, you can use the following settings in your Pelican configuration file:\n\n\tPDF_STYLE = \"\"\n\tPDF_STYLE_PATH = \"\"\n\n`PDF_STYLE_PATH` defines a new path where *rst2pdf* will look for style sheets, while `PDF_STYLE` specifies the style you want to use.\nFor a description of the available styles, please read the [rst2pdf documentation](https://rst2pdf.org/static/manual.html#styles).\n\nContributors\n------------\n\nContributors include: Dominik Wombacher, Justin Mayer, Kyle Mahan, Renato Cunha, dpetzel, and Lucas Cimon\n\nContributing\n------------\n\nContributions 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][].\n\nTo start contributing to this plugin, review the [Contributing to Pelican][] documentation, beginning with the **Contributing Code** section.\n\n[existing issues]: https://github.com/pelican-plugins/pdf/issues\n[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html\n\nLicense\n-------\n\nThis project is licensed under the AGPL 3.0 license.\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "PDF Generator is a Pelican plugin that exports articles and pages as PDF files during site generation",
"version": "1.0.5",
"project_urls": {
"Funding": "https://donate.getpelican.com/",
"Homepage": "https://github.com/pelican-plugins/pdf",
"Issue tracker": "https://github.com/pelican-plugins/pdf/issues"
},
"split_keywords": [
"pelican",
" plugin",
" pdf",
" generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "602ff721f4d75cd9358ebf1bd4cb89abf3b0635485332f0fabca8d3043e1babb",
"md5": "453b9e016563f53d6ccb35a19655f2a5",
"sha256": "9543f82937a2db740698b48ac4fc765490ef7dbb1ee5fe0388788d6d64cbc753"
},
"downloads": -1,
"filename": "pelican_pdf-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "453b9e016563f53d6ccb35a19655f2a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 17183,
"upload_time": "2024-09-11T12:55:04",
"upload_time_iso_8601": "2024-09-11T12:55:04.435540Z",
"url": "https://files.pythonhosted.org/packages/60/2f/f721f4d75cd9358ebf1bd4cb89abf3b0635485332f0fabca8d3043e1babb/pelican_pdf-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d165d66956282b698185ae3e6b1c8157a4d52bcfed268da2f89559af210a77ca",
"md5": "5382d7e912a6746d90934e291fe8d3d9",
"sha256": "4ab55e00328dc827f85255b3665acdaa7f80e29dcd5a9b836d41bcf56293ad7d"
},
"downloads": -1,
"filename": "pelican_pdf-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "5382d7e912a6746d90934e291fe8d3d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 17241,
"upload_time": "2024-09-11T12:55:05",
"upload_time_iso_8601": "2024-09-11T12:55:05.584750Z",
"url": "https://files.pythonhosted.org/packages/d1/65/d66956282b698185ae3e6b1c8157a4d52bcfed268da2f89559af210a77ca/pelican_pdf-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 12:55:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pelican-plugins",
"github_project": "pdf",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pelican-pdf"
}
