For folks who have done this before or want a zoomed-out view:
Quick reference
For folks who have done this before or are experienced devs:
- Clone the demo.
- Run
bundle install
to install dependencies. - Delete the demo-specific collection derivatives (i.e.,
_data/raw_images/qatar
,_data/qatar.csv
,img/derivatives
and_qatar
) withbundle exec rake clobber:qatar
. - Change
_layouts/qatar-item.html
to a layout for your collection. - Swap in your own directory of images and metadata file for each collection.
- Add your collection(s) to
_config.yml
(referencing your new layout), set up yoursearch
config, change sitetitle
,url
,baseurl
, etc. - Run
bundle exec rake wax:derivatives:iiif <collection-name>
ORbundle exec rake wax:derivatives:simple <collection-name>
to generate image derivatives and add their paths to your metadata file. - Run
bundle exec rake wax:pages <collection-name>
to generate the collection item pages. - Run
bundle exec rake wax:search main
to generate the Elasticlunr.js search index. - Run
bundle exec jekyll serve
to preview your site in progress. - 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. - Push the site to a new repository of your own and, if desired, enable GitHub pages.