mirror of https://github.com/saimn/sigal.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Simon Conseil
66bd01106b
|
3 years ago | |
|---|---|---|
| .github/workflows | 3 years ago | |
| docs | 3 years ago | |
| src/sigal | 3 years ago | |
| tests | 3 years ago | |
| .git-blame-ignore-revs | 5 years ago | |
| .gitignore | 4 years ago | |
| .pre-commit-config.yaml | 3 years ago | |
| .readthedocs.yml | 4 years ago | |
| AUTHORS | 3 years ago | |
| CONTRIBUTING.rst | 5 years ago | |
| LICENSE | 4 years ago | |
| MANIFEST.in | 6 years ago | |
| README.rst | 3 years ago | |
| pyproject.toml | 3 years ago | |
| setup.cfg | 3 years ago | |
| tox.ini | 3 years ago | |
README.rst
Sigal - Simple Static Gallery Generator
=======================================
.. image:: https://github.com/saimn/sigal/workflows/Run%20unit%20tests/badge.svg
:target: https://github.com/saimn/sigal/actions
:alt: CI Status
.. image:: https://codecov.io/gh/saimn/sigal/branch/main/graph/badge.svg
:target: https://codecov.io/gh/saimn/sigal
:alt: codecov.io
Sigal is yet another simple static gallery generator. It's written in Python
and it allows to build a static gallery of images with the following features:
* Process directories recursively.
* Generate HTML pages using Jinja2_ templates.
* Relative links for a portable output.
* Support themes, videos, EXIF tags, zip download.
* Parallel processing.
* MIT licensed.
The idea behind Sigal is to ease the use of the javascript libraries like
galleria_. These libraries do a great job to display the images, Sigal does
what is missing: resize images, create thumbnails, generate HTML pages.
Sigal is compatible with Python 3.5+.
Links :
* Latest documentation on the website_
* Source, issues and pull requests on GitHub_
* Releases on PyPI_
* ``#sigal`` on Freenode, or with the webchat_ interface.
Themes & Demo
-------------
Sigal comes with three themes, based on the colorbox_, galleria_ and photoswipe_
Javascript libraries:
- `colorbox demo`_
- `galleria demo`_
- `photoswipe demo`_
.. _website: http://sigal.saimon.org/
.. _GitHub: https://github.com/saimn/sigal/
.. _PyPI: https://pypi.org/project/sigal/
.. _galleria: https://github.com/GalleriaJS/galleria
.. _colorbox: http://www.jacklmoore.com/colorbox
.. _photoswipe: http://photoswipe.com
.. _galleria demo: http://saimon.org/sigal-demo/galleria/
.. _colorbox demo: http://saimon.org/sigal-demo/colorbox/
.. _photoswipe demo: http://saimon.org/sigal-demo/photoswipe/
.. _webchat: http://webchat.freenode.net/?channels=sigal
.. _Jinja2: https://palletsprojects.com/p/jinja/