minicomp/wax 🐝

Wax is an extensible workflow for producing scholarly exhibitions with minimal computing principles.
It's comprised of: a few Ruby gems for processing image data and associated metadata (wax_tasks, wax_iiif), a Jekyll theme (wax_theme), and (hopefully soon!) a lot of documentation and recipes for creating, deploying, and maintaining digital exhibitions.

• Prerequisites
• Getting Started

Prerequisites

You'll need Ruby >= 2.4 with bundler installed. Check your versions with:

$ ruby -v
  ruby 2.4.5p335 (2018-10-18 revision 65137) [x86_64-darwin18]

$ bundler -v
  Bundler version 2.0.1

To process images, you will also need to have ImageMagick and Ghostscript installed and functional. You can check to see if you have ImageMagick by running:

$ convert -version
  Version: ImageMagick 6.9.9-20 Q16 x86_64 2017-10-15 http://www.imagemagick.org
  Copyright: (c) 1999-2017 ImageMagick Studio LLC

... and check Ghostscript with:

$ gs -version
  GPL Ghostscript 9.21 (2017-03-16)
  Copyright (C) 2017 Artifex Software, Inc.  All rights reserved.

Getting Started

There are a few ways to get started with Wax, depending on your needs. Cloning the demo is suggested for new users so you can see how a full Wax site would work. Advanced Jekyllers can start from a clean Jekyll install.

Option 1: Clone the demo

1. Change directory into where you'd like your site, e.g., your Desktop: sh cd ~/Desktop
2. Clone this repository sh git clone https://github.com/minicomp/wax.git
3. Change directory into the site repository and install the dependencies: sh cd wax bundle install

4. Serve the site locally

   bundle exec jekyll serve
   

   Option 2: Start from scratch (Advanced)

5. Make a new Jekyll site and cd into it:

   jekyll new ~/Desktop/wax_site
   cd ~/Desktop/wax_site
   

6. Add this line to your Jekyll site's Gemfile:

   gem "wax_theme"
   

7. And add this line to your Jekyll site's _config.yml:

   theme: wax_theme
   

8. Install the dependencies:

   bundle install
   

9. Serve the site locally

   bundle exec jekyll serve
   

When the demo site is serving correctly you're ready to swap in your own content and configuration to make your own exhibition site.