mkdocs_nype.plugins.webp_images.config

WebpImagesConfig

Bases: Config

cache = Type(bool, default=True)

Enable cache flag

cache_dir = Type(str, default='.cache/nype/webp_images')

Cache dir location to store converted images

workers = Type(int, default=max(1, cpu_count() - 1))

Number of cores to use to process the images

lossless = Type(bool, default=False)

Lossless flag for the writer

quality = Type(int, default=80)

Quality level for the writer

extensions = Type(str, default='jpg,jpeg,png,bmp')

Comma separated string list of image extensions to convert to WebP

ignore_paths = Optional(PathSpec())

Ignored .gitignore patterns

ignore_mode = Choice(('processing', 'deletion'), default='deletion')

Ignore mode to decide if the ignored patterns should prevent processing or deletion of old images

add_sizes = Type(bool, default=True)

Add sizes (width/height) to <img> tags