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:

pip install mkdocs-pdf2image-plugin

Note that this plugin uses Edouard Belval's pdf2image package, which requires Poppler to be installed on your system. Read the installation instructions on the pdf2image repository for more information.

Activate the plugin in mkdocs.yml:

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 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.

Metadata

Release files for mkdocs-pdf2image-plugin 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-pdf2image-plugin 0.1.2
File	Size	Uploaded	Provenance
mkdocs_pdf2image_plugin-0.1.2.tar.gz	2.9 kB	Sep 12, 2023	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-pdf2image-plugin 0.1.2
File	Interpreter	ABI	Platform	Reset
mkdocs_pdf2image_plugin-0.1.2-py3-none-any.whl 3.6 kB Sep 12, 2023 Without provenance	Python 3	none	any	Details

Total release size: 6.6 kB

Release files / mkdocs_pdf2image_plugin-0.1.2.tar.gz

Download URL	mkdocs_pdf2image_plugin-0.1.2.tar.gz
Size	2.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`f0962bbb6e90e373297fcf41fc3285e8ce89ba97b4a606f225ccff7b8f3457e1`
BLAKE2b-256 checksum How to use checksums	`8b92b934b892c61b062b670cf0ba32482490ec70ebc50d0d0edbccae61320bea`
Upload date	Sep 12, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/4.0.2 CPython/3.11.5`

Release files / mkdocs_pdf2image_plugin-0.1.2-py3-none-any.whl

Download URL	mkdocs_pdf2image_plugin-0.1.2-py3-none-any.whl
Size	3.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`66cad45735204a9e6f9a40f8f2662c6b480a8995709aa44dd7c121dcc543c994`
BLAKE2b-256 checksum How to use checksums	`7ec26c1962022df2378f09ad5117c05cc69051f7aef0e416f47dba3cccac30e1`
Upload date	Sep 12, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/4.0.2 CPython/3.11.5`

Security for mkdocs-pdf2image-plugin 0.1.2

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.