Wax

Theme by Minicomp

|

Updated: 27 Nov 2023

|

168 Stars

Jekyll based framework for minimal exhibitions with IIIF

Overview

Wax is an extensible workflow for producing scholarly exhibitions with minimal computing principles. It includes Ruby gems for processing image data and metadata, a Jekyll theme, and documentation and recipes for creating, deploying, and maintaining digital exhibitions.

Features

• Ruby gems for processing image data and associated metadata
• Jekyll theme for creating digital exhibitions
• Documentation and recipes for creating, deploying, and maintaining exhibitions

Installation

1. Make sure you have git and Ruby >= 3.2 with bundler installed.
2. Install ImageMagick and Ghostscript for image processing.
3. Clone the Wax demo repository from GitHub.
4. Change directory into the cloned project folder.
5. Install the project-specific Ruby dependencies.
6. Run the demo site.

For Docker users:

1. Make sure you have Docker installed.
2. Follow steps 1-6 of the regular installation.
3. Build the minicomp/wax base image.
4. Create an interactive bash container.
5. Serve the site and view it in your host browser.

Summary

Wax is a workflow for creating scholarly exhibitions with minimal computing principles. It provides tools, such as Ruby gems and a Jekyll theme, for processing image data and creating digital exhibitions. The installation process includes setting up dependencies and cloning the Wax demo repository. Docker users can also use Wax in a container.