# mkdocs-pdf2image-plugin
This plugin generates images from the first page of PDF files. It is particularly useful when you want
to include PDF presentations in your documentation.
## Installation
Install the package with pip:
```bash
pip install mkdocs-pdf2image-plugin
```
Note that this plugin uses Edouard Belval's [pdf2image](https://github.com/Belval/pdf2image) package, which requires
[Poppler](https://poppler.freedesktop.org/) to be installed on your system. Read the [installation instructions](https://github.com/Belval/pdf2image/blob/master/README.md) on the pdf2image repository for more information.
Activate the plugin in `mkdocs.yml`:
```yaml
plugins:
- search
- pdf2image:
src:
- path/to/*.pdf
- other/**/file.pdf
dpi: 300
format: png
```
## Configuration
The plugin supports the following configuration options:
| Option | Description |
|-------------|---------------------------------------------------------------------------------------------------------------------|
| `src` | A **list** of path names to convert (see [documentation](https://docs.python.org/3/library/glob.html) for details). |
| `dpi` | Image quality in DPI (default 200). |
| `fmt` | Output image format. Valid options are `jpg` and `png`. Defaults to `jpg`. |
| `size` | Size of the generated image, defaults to `(None, None)` or `!!python/tuple [NULL, NULL]` in _YAML_. |
| `extension` | Output file extension, defaults to `fmt` option. |
| `force` | Force image creation, defaults to `false`. It `true`, the generation is done even if the image already exist. |
Raw data
{
"_id": null,
"home_page": "https://github.com/supcik/mkdocs-pdf2image-plugin",
"name": "mkdocs-pdf2image-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "mkdocs,python,markdown,wiki",
"author": "Jacques Supcik",
"author_email": "jacques.supcik@hefr.ch",
"download_url": "https://files.pythonhosted.org/packages/8b/92/b934b892c61b062b670cf0ba32482490ec70ebc50d0d0edbccae61320bea/mkdocs_pdf2image_plugin-0.1.2.tar.gz",
"platform": null,
"description": "# mkdocs-pdf2image-plugin\n\nThis plugin generates images from the first page of PDF files. It is particularly useful when you want\nto include PDF presentations in your documentation.\n\n## Installation\n\nInstall the package with pip:\n\n```bash\npip install mkdocs-pdf2image-plugin\n```\n\nNote that this plugin uses Edouard Belval's [pdf2image](https://github.com/Belval/pdf2image) package, which requires\n[Poppler](https://poppler.freedesktop.org/) to be installed on your system. Read the [installation instructions](https://github.com/Belval/pdf2image/blob/master/README.md) on the pdf2image repository for more information.\n\nActivate the plugin in `mkdocs.yml`:\n\n```yaml\nplugins:\n - search\n - pdf2image:\n src:\n - path/to/*.pdf\n - other/**/file.pdf\n dpi: 300\n format: png\n```\n\n## Configuration\n\nThe plugin supports the following configuration options:\n\n| Option | Description |\n|-------------|---------------------------------------------------------------------------------------------------------------------|\n| `src` | A **list** of path names to convert (see [documentation](https://docs.python.org/3/library/glob.html) for details). |\n| `dpi` | Image quality in DPI (default 200). |\n| `fmt` | Output image format. Valid options are `jpg` and `png`. Defaults to `jpg`. |\n| `size` | Size of the generated image, defaults to `(None, None)` or `!!python/tuple [NULL, NULL]` in _YAML_. |\n| `extension` | Output file extension, defaults to `fmt` option. |\n| `force` | Force image creation, defaults to `false`. It `true`, the generation is done even if the image already exist. |\n\n",
"bugtrack_url": null,
"license": "Apache-2",
"summary": "An MkDocs plugin to convert the first page of a pdf to an image",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/supcik/mkdocs-pdf2image-plugin",
"Repository": "https://github.com/supcik/mkdocs-pdf2image-plugin"
},
"split_keywords": [
"mkdocs",
"python",
"markdown",
"wiki"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7ec26c1962022df2378f09ad5117c05cc69051f7aef0e416f47dba3cccac30e1",
"md5": "f1dc9b5e108bfbe404d0e16d548d1104",
"sha256": "66cad45735204a9e6f9a40f8f2662c6b480a8995709aa44dd7c121dcc543c994"
},
"downloads": -1,
"filename": "mkdocs_pdf2image_plugin-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f1dc9b5e108bfbe404d0e16d548d1104",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 3607,
"upload_time": "2023-09-12T11:44:33",
"upload_time_iso_8601": "2023-09-12T11:44:33.462767Z",
"url": "https://files.pythonhosted.org/packages/7e/c2/6c1962022df2378f09ad5117c05cc69051f7aef0e416f47dba3cccac30e1/mkdocs_pdf2image_plugin-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b92b934b892c61b062b670cf0ba32482490ec70ebc50d0d0edbccae61320bea",
"md5": "7e01b844a8fbda9ac4aaae6b3794c73b",
"sha256": "f0962bbb6e90e373297fcf41fc3285e8ce89ba97b4a606f225ccff7b8f3457e1"
},
"downloads": -1,
"filename": "mkdocs_pdf2image_plugin-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "7e01b844a8fbda9ac4aaae6b3794c73b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 2948,
"upload_time": "2023-09-12T11:44:34",
"upload_time_iso_8601": "2023-09-12T11:44:34.899830Z",
"url": "https://files.pythonhosted.org/packages/8b/92/b934b892c61b062b670cf0ba32482490ec70ebc50d0d0edbccae61320bea/mkdocs_pdf2image_plugin-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-12 11:44:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "supcik",
"github_project": "mkdocs-pdf2image-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-pdf2image-plugin"
}
JSON
