splat is a command line application to generate static photo galleries from a source directory of image files. It is a spiritual cousin of sigal but written in Rust.
- Generates static galleries for no-nonsense hosting.
- Easy installation and simple usage.
- Clean and beautiful Tailwind CSS based builtin theme.
For 64-bit Linux systems you can install pre-built binaries from the releases. For other systems, building and installing from source can be done via
cargo install --path .splat is a command line application and besides a source directory of image
files it requires a splat.toml configuration file and a theme file containing
an HTML template as well as optional assets and descriptions in index.md
files.
To create an example configuration run splat new and edit splat.toml to your
liking, especially adapt the input and output paths. output will be
created if it does not exist. Then run splat build to generate the static
output.
Important
The example theme relies on the Tailwind CSS v4.0 compiler. Make sure to install it if you want to use the theme.
You can adjust the chosen collection thumbnail and title (which defaults to the
directory name) as well as add a description by adding an index.md file. The
first rows matching Title: or Thumbnail: will override the defaults,
anything else will be used as a description. Here is an example:
Title: Sunny vacation
Thumbnail: beach.jpg
Vacation was _just_ perfect!Templates must be written in tera syntax. The following hierarchy of variables is available:
collectiontitleof this collectionbreadcrumbspathto the corresponding pagetitleof the corresponding page
childrenof sub-collectionspathto the collectiontitleof the collectionthumbnailof the collection
imagesfor this collectionpathto the imagewidthandheightof the imagethumbnailof the image
