https://github.com/foliant-docs/foliantcontrib.imgconvert
Preprocessor for Foliant that converts images from different formats to PNG.
https://github.com/foliant-docs/foliantcontrib.imgconvert
Last synced: 5 months ago
JSON representation
Preprocessor for Foliant that converts images from different formats to PNG.
- Host: GitHub
- URL: https://github.com/foliant-docs/foliantcontrib.imgconvert
- Owner: foliant-docs
- License: mit
- Created: 2019-09-10T13:34:27.000Z (almost 7 years ago)
- Default Branch: develop
- Last Pushed: 2019-09-10T13:39:38.000Z (almost 7 years ago)
- Last Synced: 2025-08-20T15:27:22.740Z (10 months ago)
- Language: Python
- Size: 3.91 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ImgConvert
ImgConvert is a tool to convert images from an arbitrary format into PNG.
## Installation
```bash
$ pip install foliantcontrib.imgconvert
```
## Config
To enable the preprocessor, add `imgconvert` to `preprocessors` section in the project config:
```yaml
preprocessors:
- imgconvert
```
The preprocessor has a number of options with the following default values:
```yaml
preprocessors:
- imgconvert:
convert_path: convert
cache_dir: !path .imgconvertcache
image_width: 0
formats: {}
```
`convert_path`
: Path to `convert` binary. By default, it is assumed that you have this command in `PATH`. [ImageMagick](https://imagemagick.org/) must be installed.
`cache_dir`
: Directory to store processed images. They may be reused later.
`image_width`
: Width of PNG images in pixels. By default (in case when the value is `0`), the width of each image is set by ImageMagick automatically. Default behavior is recommended. If the width is given explicitly, file size may increase.
`formats`
: Settings that apply to each format of source images.
The `formats` option may be used to define lists of targets for each format. If targets for a format are not specified explicitly, the preprocessor will be applied to all targets.
Example:
```yaml
formats:
eps:
targets:
- site
svg:
targets:
- docx
```
Formats should be named in lowercase.