https://github.com/foliant-docs/foliantcontrib.imagemagick

ImageMagick preprocessor for Foliant.
https://github.com/foliant-docs/foliantcontrib.imagemagick

Last synced: 5 months ago
JSON representation

ImageMagick preprocessor for Foliant.

• Host: GitHub
• URL: https://github.com/foliant-docs/foliantcontrib.imagemagick
• Owner: foliant-docs
• License: mit
• Created: 2018-05-16T17:11:46.000Z (about 8 years ago)
• Default Branch: develop
• Last Pushed: 2020-07-16T08:03:27.000Z (almost 6 years ago)
• Last Synced: 2025-11-27T13:42:11.219Z (7 months ago)
• Language: Python
• Size: 8.79 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![](https://img.shields.io/pypi/v/foliantcontrib.imagemagick.svg)](https://pypi.org/project/foliantcontrib.imagemagick/) [![](https://img.shields.io/github/v/tag/foliant-docs/foliantcontrib.imagemagick.svg?label=GitHub)](https://github.com/foliant-docs/foliantcontrib.imagemagick)

# ImageMagick Preprocessor

This tool provides additional processing of images that referred in Markdown source, with [ImageMagick](https://imagemagick.org/).

## Installation

```bash

$ pip install foliantcontrib.imagemagick

```

## Config

To enable the preprocessor, add `imagemagick` to `preprocessors` section in the project config:

```yaml

preprocessors:

    - imagemagick

```

The preprocessor has a number of options with the following default values:

```yaml

preprocessors:

    - imagemagick:

        convert_path: convert

        cache_dir: .imagemagickcache

```

`convert_path`

:   Path to `convert` binary, a part of ImageMagick.

`cache_dir`

:   Directory to store processed images. These files can be reused later.

## Usage

Suppose you want to apply the following command to your picture `image.eps`:

```bash

$ convert image.eps -resize 600 -background Orange label:'Picture' +swap -gravity Center -append image.jpg

```

This command takes the source EPS image `image.eps`, resizes it, puts a text label over the picture, and writes the result into new file `image.jpg`. The suffix of output file name specifies that the image must be converted into JPEG format.

To use the ImageMagick preprocessor to do the same, enclose one or more image references in your Markdown source between `` and `` tags.

```markdown

(leading exclamation mark here)[Optional Caption](image.eps)

```

Use `output_format` attribute to specify the suffix of output file name. The whole output file name will be generated automatically.

Use `command_params` attribute to specify the string of parameters that should be passed to ImageMagick `convert` binary.

Instead of using `command_params` attribute, you may specify each parameter as its own attribute with the same name:

```markdown

(leading exclamation mark here)[Optional Caption](image.eps)

```