Images

MkDocs Image Handling

2025-01-08

Install Deps

Image processing libs for enhanced image processing:

activate .venv/bin/activate  # use proj venv
pip install "mkdocs-material[imaging]"
apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
apt-get install pngquant

Restart dev env to load rqd env vars.

Configure Extensions

To add alignment, captioning and lazing-loading capabilities, add to mkdocs.yml:

markdown_extensions:
  - attr_list
  - md_in_html

See attr_list and md_in_html for config deets.

Zoom Plugin

Install:

source .venv/bin/activate
pip install mkdocs-glightbox

Configure:

plugins:
  - glightbox

Refer to glightbox for config options.

 

Copyright @ 2024 Anne Brown