Skip to main content

Collect images from a directory tree and add them to a markdown file.

Project description

imdown

imdown (pronounce "I'm down") can be used to collect images from a directory tree and put them into a markdown file for markdown to compile to another format (although I typically use pdf's so its targeted at that mainly.)

install

Install from PyPI:

pip install imdown

or from GitHub:

pip install git+https://github.com/LeSasse/imdown.git

use

You can try it out on the example provided in this repository. Go to the example directory:

git clone https://github.com/LeSasse/imdown.git
cd imdown/example

Collect all images from the figures directory and put them into a markdown file:

imdown figures -o markdown_files/all_filetypes.md

and see the result in markdown_files/all_filetypes.md. Or filter out a specific filetype only i.e. pdf's:

imdown figures -f pdf -o markdown_files/only_pdfs.md

You can then manually adjust the markdown file and compile via pandoc. If you do not need to adjust it and just want the pdf, you can also skip the intermediate markdown file and pipe it straight into pandoc (of course for this you need pandoc installed!):

imdown figures -f pdf | pandoc -o output_pdfs/piped.pdf

and see the result in output_pdfs/piped.pdf.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

imdown-0.0.1.dev4.tar.gz (312.8 kB view hashes)

Uploaded Source

Built Distribution

imdown-0.0.1.dev4-py3-none-any.whl (15.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page