pandoc-img-glob
pandoc-img-glob is a panflute pandoc filter.
In multi file and GitHub stored markdown projects, many images are specified relative to their documents. For example consider the following document tree:
example |-- section1 | |-- image1.png | `-- section1.md |-- section2 | |-- images | | |-- image3.png | | `-- image2.png | `-- section2.md `-- Makefile
Assuming the Makefile would compile my full book, it might look like this:
book:
pandoc -o book.pdf section*/*.md
And in section1.md there would be a line referencing image1.png, etc. This is often used because then the GitHub preview looks awesome! However, pandoc has no way of telling where files came from, so it loses track of image references, resulting in errors like this:
[pandoc warning] Could not find image `image1.png', skipping... [pandoc warning] Could not find image `images/image2.png', skipping... [pandoc warning] Could not find image `images/image3.png', skipping...
pandoc-img-glob solves this problem by just searching recursivly through the path find images matching the given filenames and providing pandoc (and pandoc only) with the absolute paths. This allows for both: Beautiful pdfs and GitHub previews using the updated Makefile.
fixedbook:
pandoc --filter pandoc-img-glob -o book.pdf section*/*.md
However, this filter becomes slow if you have very deep and complex file trees, and if you have multiple images with the same name, it will just silently use the first it finds.
Installation
Just use pip to install it from pypi
pip install pandoc-img-glob
Metadata
Release files for pandoc-img-glob 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pandoc-img-glob-0.1.3.tar.gz | 3.7 kB | Without provenance | Details for pandoc-img-glob-0.1.3.tar.gz |
Release files / pandoc-img-glob-0.1.3.tar.gz
| Download URL | pandoc-img-glob-0.1.3.tar.gz |
|---|---|
| Size | 3.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
40042dbd3a7497c7ba8adb65ff37e96178aa20a3076df6cec6af719f722cfdf7
|
|
BLAKE2b-256 checksum How to use checksums |
bca002bbb3a19b71325db4d6d0b7334d9c3ab3e6718c299370ce177c2283846d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for pandoc-img-glob 0.1.3
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.