Документация платформы Citeck

Документация для платформы Citeck — low-code платформа для управления бизнес-процессами, документами и задачами.

Требования

• Python 3.12+
• pre-commit — git-хуки для автоматического сжатия изображений
• pngquant — сжатие PNG
• jpegoptim — сжатие JPEG
• gifsicle — сжатие GIF
• webp — сжатие WebP (cwebp)

macOS

brew install pngquant jpegoptim gifsicle webp pre-commit

Ubuntu/Debian

sudo apt install pngquant jpegoptim gifsicle webp
pip install pre-commit

Windows

choco install pngquant jpegoptim gifsicle libwebp
pip install pre-commit

Или через Scoop:

scoop install pngquant jpegoptim gifsicle libwebp
pip install pre-commit

Настройка

pip install -r docs/requirements.txt
pre-commit install

После pre-commit install каждый коммит с изображениями будет автоматически сжимать их.

Ручной запуск сжатия

Если pre-commit хук не настроен, можно сжать изменённые изображения перед коммитом вручную:

python3 scripts/compress-images.py path/to/image1.png path/to/image2.jpg

Для сжатия всех изображений в репозитории:

pre-commit run compress-images --all-files

Локальная сборка

cd docs
make html

Результат сборки будет в _build/html/. Для просмотра в браузере:

python3 -m http.server 8030 --directory _build/html/

Затем откройте http://localhost:8030.