mirror of https://github.com/wanadev/yoga.git
58 lines
2.0 KiB
ReStructuredText
58 lines
2.0 KiB
ReStructuredText
Welcome to YOGA's documentation!
|
|
================================
|
|
|
|
|Github| |Discord| |PYPI Version| |Build Status| |Black| |License|
|
|
|
|
.. figure:: https://github.com/wanadev/yoga/raw/master/logo.png
|
|
:alt:
|
|
|
|
**YOGA** is a command-line tool and a library that can:
|
|
|
|
* convert and optimize images from various format to JPEG, PNG and WEBP,
|
|
* convert and optimize 3D models from various formats to `glTF and GLB`_.
|
|
|
|
**Images** are opened using Pillow_ and optimized using Guetzli_ and MozJPEG_
|
|
for JPEGs, Zopflipng_ for PNGs and libwebp_ for WEBPs.
|
|
|
|
**3D Models** are converted and optimized using assimp_. If models contain or
|
|
reference images, they are processed by YOGA's image optimizer.
|
|
|
|
.. _glTF and GLB: https://www.khronos.org/gltf/
|
|
.. _Pillow: https://github.com/python-pillow/Pillow
|
|
.. _Guetzli: https://github.com/google/guetzli
|
|
.. _MozJPEG: https://github.com/mozilla/mozjpeg
|
|
.. _Zopflipng: https://github.com/google/zopfli
|
|
.. _libwebp: https://chromium.googlesource.com/webm/libwebp/
|
|
.. _assimp: https://github.com/assimp/assimp
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
./install.rst
|
|
./cli/index.rst
|
|
./python/index.rst
|
|
./contributing.rst
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
|
|
|
|
|
|
.. |Github| image:: https://img.shields.io/github/stars/wanadev/yoga?label=Github&logo=github
|
|
:target: https://github.com/wanadev/yoga
|
|
.. |Discord| image:: https://img.shields.io/badge/chat-Discord-8c9eff?logo=discord&logoColor=ffffff
|
|
:target: https://discord.gg/BmUkEdMuFp
|
|
.. |PYPI Version| image:: https://img.shields.io/pypi/v/yoga.svg
|
|
:target: https://pypi.python.org/pypi/yoga
|
|
.. |Build Status| image:: https://github.com/wanadev/yoga/workflows/Python%20CI/badge.svg
|
|
:target: https://github.com/wanadev/yoga/actions
|
|
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
:target: https://black.readthedocs.io/en/stable/
|
|
.. |License| image:: https://img.shields.io/pypi/l/yoga.svg
|
|
:target: https://github.com/wanadev/yoga/blob/master/LICENSE
|