Files
sigal/README.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

55 lines
1.8 KiB
ReStructuredText
Raw Permalink Normal View History

2013-05-06 23:33:09 +02:00
Sigal - Simple Static Gallery Generator
=======================================
2012-05-13 22:37:28 +02:00
2020-10-04 22:04:50 -03:00
.. image:: https://github.com/saimn/sigal/workflows/Run%20unit%20tests/badge.svg
:target: https://github.com/saimn/sigal/actions
2020-10-04 19:32:21 -03:00
:alt: CI Status
2012-11-27 22:18:03 +01:00
2021-04-19 00:53:56 +02:00
.. image:: https://codecov.io/gh/saimn/sigal/branch/main/graph/badge.svg
2018-01-03 19:12:11 +01:00
:target: https://codecov.io/gh/saimn/sigal
2018-01-03 18:15:27 +01:00
:alt: codecov.io
2014-10-15 22:55:02 +02:00
2012-11-09 00:42:16 +01:00
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:
2012-05-13 22:37:28 +02:00
2013-05-06 23:33:09 +02:00
* Process directories recursively.
* Generate HTML pages using Jinja2_ templates.
2013-05-06 23:33:09 +02:00
* Relative links for a portable output.
2013-09-06 00:33:47 +02:00
* Support themes, videos, EXIF tags, zip download.
2013-12-26 17:59:57 +01:00
* Parallel processing.
2012-11-09 00:42:16 +01:00
* MIT licensed.
2012-05-13 22:37:28 +02:00
2015-04-01 15:07:55 +02:00
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.
2023-11-08 23:34:21 +01:00
Sigal requires Python 3.9+.
2023-11-08 23:24:40 +01:00
Links
-----
2012-05-13 22:37:28 +02:00
2014-08-25 22:02:04 +02:00
* Latest documentation on the website_
2015-04-01 15:07:55 +02:00
* Source, issues and pull requests on GitHub_
2014-08-25 22:02:04 +02:00
* Releases on PyPI_
2012-05-13 22:37:28 +02:00
2013-08-19 00:26:29 +02:00
Themes & Demo
-------------
2015-09-07 22:24:18 +02:00
Sigal comes with three themes, based on the colorbox_, galleria_ and photoswipe_
2013-08-19 00:26:29 +02:00
Javascript libraries:
- `colorbox demo`_
- `galleria demo`_
2015-09-07 22:24:18 +02:00
- `photoswipe demo`_
2013-08-19 00:26:29 +02:00
2012-11-14 00:47:36 +01:00
.. _website: http://sigal.saimon.org/
2015-04-01 15:07:55 +02:00
.. _GitHub: https://github.com/saimn/sigal/
.. _PyPI: https://pypi.org/project/sigal/
.. _galleria: https://github.com/GalleriaJS/galleria
2013-08-19 00:26:29 +02:00
.. _colorbox: http://www.jacklmoore.com/colorbox
2015-09-07 22:24:18 +02:00
.. _photoswipe: http://photoswipe.com
2013-08-19 00:26:29 +02:00
.. _galleria demo: http://saimon.org/sigal-demo/galleria/
.. _colorbox demo: http://saimon.org/sigal-demo/colorbox/
2015-09-07 22:24:18 +02:00
.. _photoswipe demo: http://saimon.org/sigal-demo/photoswipe/
2020-10-10 09:55:23 +00:00
.. _Jinja2: https://palletsprojects.com/p/jinja/