Quick reference

  1. Clone the demo. (Make sure to clone the gh-pages branch if you want to use GitHub pages!)
  2. Run bundle install to install dependencies.
  3. Delete the demo-specific collection files and directories (i.e., _data/raw_images/qatar, _data/qatar.csv, _qatar, js/lunr-index.json, js/lunr-ui.js).
  4. Change _layouts/qatar-item.html to a layout for your collection.
  5. Swap in your own directory of images and metadata file for each collection.
  6. Add your collection(s) to _config.yml (referencing your new layout), set up your lunr_index config, change site title, url, baseurl, etc.
  7. Run bundle exec rake wax:derivatives:iiif <collection-name> OR bundle exec rake wax:derivatives:simple <collection-name> to generate image derivatives and add their paths to your metadata file.
  8. Run bundle exec rake wax:pagemaster <collection-name> to generate the collection item pages.
  9. Run bundle exec rake wax:lunr UI=true to generate the Elasticlunr.js search index with a default UI to use.
  10. Run bundle exec jekyll serve to preview your site in progress.
  11. Adjust the menu settings in _config.yml, update the content on the pages, change the metadata for your collection pages, and so on until your site is ready.
  12. Push the site to a new repository of your own and enable GitHub pages.

Speed run