Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Sigal 2.6.dev5+g28a576a documentation
Sigal 2.6.dev5+g28a576a documentation
  • Installation
  • Getting started
  • Configuration
  • Album information
  • Image information
  • Themes
  • Plugins
  • Frequently Asked Questions (FAQ)
  • Contributing guidelines
  • License
  • Changelog
Back to top
View this page
Edit this page

Sigal - Simple Static Gallery Generator¶

CI Status 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 requires Python 3.9+.

Links¶

  • Latest documentation on the website

  • Source, issues and pull requests on GitHub

  • Releases on PyPI

Themes & Demo¶

Sigal comes with three themes, based on the colorbox, galleria and photoswipe Javascript libraries:

  • colorbox demo

  • galleria demo

  • photoswipe demo

Documentation¶

  • Installation
    • Dependencies
    • Packages
  • Getting started
    • How to Use
    • Help on the sigal build command
    • Help on the sigal serve command
  • Configuration
  • Album information
  • Image information
  • Themes
    • Bundled themes
    • Creating a theme
    • Variables
    • Filters
    • Documentation of sigal’s main classes
    • Simpler EXIF data output
  • Plugins
    • How to use plugins
    • Write a new plugin
    • Signals
    • List of plugins
  • Frequently Asked Questions (FAQ)
    • How do I protect the gallery with a password?
    • How do I protect only some folders of the gallery with a password?
    • How to regenerate the gallery when something changes ?
    • How to automatically build the gallery on a remote git server?
  • Contributing guidelines
    • Filing issues
    • How To Contribute
    • Setting up the development environment
    • Building the docs
    • Running the test suite
    • Building the test gallery
  • License
  • Changelog
    • Version 2.6dev
    • Version 2.5
    • Version 2.4
    • Version 2.3
    • Version 2.2
    • Version 2.1.1
    • Version 2.1
    • Version 2.0
    • Version 1.4.1
    • Version 1.4.0
    • Version 1.3.0
    • Version 1.2.0
    • Version 1.1.0
    • Version 1.0.1
    • Version 1.0.0
    • Version 0.9.2
    • Version 0.9.1
    • Version 0.9.0
    • Version 0.8.1
    • Version 0.8.0
    • Version 0.7
    • Version 0.6.0
    • Version 0.5.1
    • Version 0.5.0
    • Version 0.4.1
    • Version 0.4.0
    • Version 0.3.3
    • Version 0.3.2
    • Version 0.3.1
    • Version 0.3
    • Version 0.2
    • Version 0.1
Next
Installation
Copyright © 2012-2023, Simon Conseil
Made with Sphinx and @pradyunsg's Furo
On this page
  • Sigal - Simple Static Gallery Generator
    • Links
    • Themes & Demo
    • Documentation